Interface JRTCMediaDeviceCallback

音视频设备相关事件回调

interface JRTCMediaDeviceCallback {
    onVolumeChanged(volume: number, userId?: string): void;
    onCameraError?(code: number, reason: string): void;
    onAudioInputError?(code: number, reason: string): void;
    onCameraUpdate?(time: undefined | string): void;
    onAudioInputUpdate?(): void;
    onSendResolutionChangedNotify?(isReduced: boolean, currentWidth: number, currentHeight: number, reason?: string, networkStats?: any): void;
    onStreamRefresh?(newStream: MediaStream): void;
}

Hierarchy

  • JRTCMediaDeviceCallbackBase
    • JRTCMediaDeviceCallback

Methods

onVolumeChanged onCameraError? onAudioInputError? onCameraUpdate? onAudioInputUpdate? onSendResolutionChangedNotify? onStreamRefresh?

Methods

onVolumeChanged

  • onVolumeChanged(volume, userId?): void

  • 媒体音量上报

    Parameters

    • volume: number

      音量值 0～100

    • OptionaluserId: string

      用户ID，如果为空代表本地音量

    Returns void

OptionalonCameraError

  • onCameraError(code, reason): void

  • 摄像头报错回调

    Parameters

    • code: number

      事件码 C21_OPEN_CAMERA_NOT_PERMISSION(111013) - 无权限， C21_OPEN_CAMERA_FAIL(111014) - 其他原因 C21_CLOSE_CAMERA(111015) - 中途异常关闭摄像头

    • reason: string

      错误说明

    Returns void

OptionalonAudioInputError

  • onAudioInputError(code, reason): void

  • 麦克风报错回调

    Parameters

    • code: number

      事件码 C21_START_AUDIO_INPUT_NOT_MIC_PERMISSION(111005) - 无权限， C21_START_AUDIO_INPUT_FAIL(111006) - 其他原因 C21_STOP_AUDIO_INPUT(111008) - 中途异常关闭麦克风

    • reason: string

    Returns void

OptionalonCameraUpdate

  • onCameraUpdate(time): void

  • 摄像头变化回调

    摄像头状态发生变化会收到此回调，例如打开、关闭、切换摄像头

    Parameters

    • time: undefined | string

      如果是开启摄像头的变化，可能会存在一个开启时间。其他情况time为undefined

    Returns void

OptionalonAudioInputUpdate

  • onAudioInputUpdate(): void

  • 输入音频变化回调

    音频状态发生变化会收到此回调，例如打开、关闭输入音频（麦克风）

    Returns void

OptionalonSendResolutionChangedNotify

  • onSendResolutionChangedNotify(isReduced, currentWidth, currentHeight, reason?, networkStats?): void

  • 发送分辨率变化回调

    当检测到发送分辨率变化时触发此回调

    Parameters

    • isReduced: boolean

      是否降低分辨率

    • currentWidth: number

      当前发送的视频宽度

    • currentHeight: number

      当前发送的视频高度

    • Optionalreason: string

      变化原因

    • OptionalnetworkStats: any

      网络统计数据，包含码率、丢包率等信息

    Returns void

OptionalonStreamRefresh

  • onStreamRefresh(newStream): void

  • 媒体流刷新回调

    当媒体设备需要重新推流时触发此回调，例如摄像头分辨率变化

    Parameters

    • newStream: MediaStream

      新的媒体流

    Returns void

设置

主题