Class JRTCMediaDevice

Hierarchy

Methods

setSupportMediaType setAudioInputFrameCallback setVideoCaptureFrameCallback create destroy notifyProcessLog getAudioInputs getAudioOutputs setCameraProperty setCameraCaptureDegradationPreference startCameraVideo startVideo stopVideo stopAllMedia startAudioInput stopAudioInput startAudioOutput stopAudioOutput switchCamera enableScreenCapture onVisibilityChange enableAudioInputFromFile mixMediaStream stopMediaStream isCameraOpen getCurrentCamera getCameras isAudioStart specifyCamera setMinSendResolution notifySendResolutionChanged onProcessLog

Methods

setSupportMediaType

  • setSupportMediaType(mediaType): void

  • Parameters

    Returns void

setAudioInputFrameCallback

  • setAudioInputFrameCallback(callback): void

  • 设置监听本地麦克风音频流二进制数据回调上报

    Parameters

    • callback: undefined | ((data: Float32Array, sampleRate: number, channel: number) => void)

      回调函数，传入 undefined 停止上报

    Returns void

setVideoCaptureFrameCallback

  • setVideoCaptureFrameCallback(callback): void

  • 设置监听本地摄像头视频流二进制数据回调上报

    Parameters

    • callback: undefined | ((data: ImageData, width: number, height: number) => void)

      回调函数，传入 undefined 停止上报

    Returns void

Staticcreate

  • create(callback, initParam, client?): undefined | JRTCMediaDevice

  • 创建 JRTCMediaDevice 对象

    Parameters

    Returns undefined | JRTCMediaDevice

    JRTCMediaDevice 对象

    Note

    • 调用此方法创建 JRTCMediaDevice 对象后，期间没有调用过 destroy 方法销毁对象，然后又重复调用此方法，会直接返回第一次创建的 JRTCMediaDevice 对象

    See

    JRTCMediaDeviceInitParam

    Throws

    Error "初次创建时 JRTCMediaDeviceCallback 参数传空就会创建失败"

Staticdestroy

  • destroy(): void

  • 销毁 JRTCMediaDevice 对象

    Returns void

    Note

    该方法为同步调用，需要等待 JRTCMediaDevice 实例资源释放后才能执行其他操作，调用此方法后，你将无法再使用 JRTCMediaDevice 的其它方法和回调。
    我们 不建议 在 JRTCSDK 的回调中调用此方法销毁 JRTCMediaDevice 对象，否则会出现崩溃。
    如需在销毁后再次创建 JRTCMediaDevice 实例，需要等待 destroy 方法执行结束后再创建实例。

notifyProcessLog

  • notifyProcessLog(message, level, source?): void

  • 发送日志消息

    Parameters

    • message: string

      日志消息

    • level: JRTCLogLevel

      日志级别

    • Optionalsource: string

      消息源

    Returns void

getAudioInputs

getAudioOutputs

setCameraProperty

  • setCameraProperty(width, height, frameRate): void

  • 设置摄像头采集属性

    在调用开启摄像头视频预览接口之前设置即可生效

    Parameters

    • width: number

      采集宽度，默认为 640

    • height: number

      采集高度，默认为 360

    • frameRate: number

      采集帧速率，默认为 24

    Returns void

    Note

    小程序采集帧率目前不生效

setCameraCaptureDegradationPreference

  • setCameraCaptureDegradationPreference(degradationPreference): void

  • 设置摄像头采集降级策略

    Parameters

    • degradationPreference: DegradationPreference

      策略选择

      • MAINTAIN_RESOLUTION: 分辨率优先 - 保持视频分辨率，必要时降低帧率
      • MAINTAIN_FRAMERATE: 帧率优先 - 保持视频帧率，必要时降低分辨率
      • BALANCED: 平衡模式 - 在分辨率和帧率之间进行平衡

    Returns void

startCameraVideo

  • startCameraVideo(renderType, videoBox): Promise<JRTCMediaDeviceVideoCanvas>

  • 开始本端身视频渲染

    获取本端视频预览对象 JRTCMediaDeviceVideoCanvas，通过此对象能获得视图用于UI显示

    Parameters

    • renderType: RenderType

      视频渲染模式

    • videoBox: HTMLElement

      需要包含视频视图的组件

    Returns Promise<JRTCMediaDeviceVideoCanvas>

    Promise

startVideo

  • startVideo(streamUrl, renderType, mediaStream, videoBox): undefined | JRTCMediaDeviceVideoCanvas

  • 开始远端视频渲染

    Parameters

    • streamUrl: string

      远端视频拉流地址

    • renderType: RenderType

      视频渲染模式

    • mediaStream: MediaStream

      媒体流对象，可以通过订阅远端视频流获取

    • videoBox: HTMLElement

      需要包含视频视图的组件

    Returns undefined | JRTCMediaDeviceVideoCanvas

    • JRTCMediaDeviceVideoCanvas 对象: 开始远端视频渲染成功
    • undefined: 开始远端视频渲染失败

stopVideo

stopAllMedia

  • stopAllMedia(): void

  • 关闭所有媒体资源，包括远端和本端音视频

    Returns void

startAudioInput

  • startAudioInput(volumeReportIntervalMs?): Promise<boolean>

  • 打开音频输入

    Parameters

    • OptionalvolumeReportIntervalMs: number

      本端音量上报间隔，单位毫秒；不传则不做本端音量上报

    Returns Promise<boolean>

    Promise

stopAudioInput

  • stopAudioInput(): boolean

  • 关闭音频输入

    Returns boolean

    • true: 关闭音频输入成功
    • false: 关闭音频输入失败

startAudioOutput

  • startAudioOutput(mediaStream, userId, audioBox?): undefined | JRTCMediaDeviceAudioContainer

  • 打开指定远端用户的音频输出

    Parameters

    • mediaStream: MediaStream

      音频流对象

    • userId: string

      用户ID

    • OptionalaudioBox: HTMLElement

      需要包含音频视图的组件

    Returns undefined | JRTCMediaDeviceAudioContainer

    • JRTCMediaDeviceAudioContainer 对象: 打开音频输出成功
    • undefined: 打开音频输出失败

    Note

    audioBox不传可能无法播放音频

stopAudioOutput

  • stopAudioOutput(userId?): boolean

  • 关闭音频输出

    Parameters

    • OptionaluserId: string

      用户ID，如果不设置userId，暂停全部音频输出

    Returns boolean

    • true: 关闭音频输出成功
    • false: 关闭音频输出失败

switchCamera

  • switchCamera(camera?): Promise<boolean>

  • 切换摄像头/切换到指定摄像头

    Parameters

    Returns Promise<boolean>

    Promise

    Note

    当 camera 不传内部会根据当前摄像头类型来进行切换

    • 调用此方法时要保证摄像头已打开
    • 设备拥有两个以上摄像头

enableScreenCapture

  • enableScreenCapture(enable): Promise<undefined | MediaStream>

  • 开启/关闭屏幕采集

    Parameters

    • enable: boolean

      是否开启

    Returns Promise<undefined | MediaStream>

    媒体流对象

onVisibilityChange

  • onVisibilityChange(ev): void

  • Parameters

    • ev: any

    Returns void

enableAudioInputFromFile

  • enableAudioInputFromFile(enable, mediaStream?): Promise<boolean>

  • 开始/结束音频混音流输入

    Parameters

    • enable: boolean
    • OptionalmediaStream: MediaStream

      混音流对象，如果结束混音，可不传

    Returns Promise<boolean>

    Note

    通话过程中，可以调用该方法开启将音频流和麦克风合进行混音，并推到远端。

mixMediaStream

  • mixMediaStream(mediaStream): Promise<void>

  • 打开音频混音

    Parameters

    • mediaStream: MediaStream

      混音流对象

    Returns Promise<void>

    Note

    将播放的音频和麦克风合流推到远端。

stopMediaStream

  • stopMediaStream(): Promise<void>

  • 停止音频混音

    Returns Promise<void>

isCameraOpen

  • isCameraOpen(): boolean

  • 摄像头是否打开

    Returns boolean

    摄像头是否打开

getCurrentCamera

getCameras

isAudioStart

  • isAudioStart(): boolean

  • 音频设备是否打开

    Returns boolean

    音频设备是否打开

specifyCamera

  • specifyCamera(camera): void

  • 指定要开启的摄像头，在调用开启摄像头视频预览接口之前设置即可生效

    Parameters

    Returns void

setMinSendResolution

  • setMinSendResolution(width, height): void

  • 设置最小发送分辨率

    Parameters

    • width: number

      最小发送宽度

    • height: number

      最小发送高度

    Returns void

notifySendResolutionChanged

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

  • 通知发送分辨率变化警告

    Parameters

    • isReduced: boolean

      是否降低分辨率

    • currentWidth: number

      当前发送的视频宽度

    • currentHeight: number

      当前发送的视频高度

    • Optionalreason: string

      变化原因，可选

    • OptionalnetworkStats: any

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

    Returns void

onProcessLog

  • onProcessLog(message, level, source?): void

  • Parameters

    Returns void

设置

主题