Class JRTCMediaDevice

Hierarchy

Methods

setSupportMediaType create destroy getAudioInputs getAudioOutputs setCameraProperty startCameraVideo startVideo stopVideo stopAllMedia startAudioInput stopAudioInput startAudioOutput stopAudioOutput switchCamera onVisibilityChange isCameraOpen getCurrentCamera getCameras isAudioStart

Methods

setSupportMediaType

  • setSupportMediaType(mediaType): void

  • Parameters

    Returns void

Static create

  • create(callback, initParam): undefined | JRTCMediaDevice

  • 创建 JRTCMediaDevice 对象

    Parameters

    Returns undefined | JRTCMediaDevice

    JRTCMediaDevice 对象

    Note

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

    See

    JRTCMediaDeviceInitParam

    Throws

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

Static destroy

  • destroy(): void

  • 销毁 JRTCMediaDevice 对象

    Returns void

    Note

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

getAudioInputs

getAudioOutputs

setCameraProperty

  • setCameraProperty(width, height, frameRate): void

  • 设置摄像头采集属性

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

    Parameters

    • width: number

      采集宽度，默认为 640

    • height: number

      采集高度，默认为 360

    • frameRate: number

      采集帧速率，默认为 24

    Returns void

    Note

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

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(): Promise<boolean>

  • 打开音频输入

    Returns Promise<boolean>

    Promise

stopAudioInput

  • stopAudioInput(): boolean

  • 关闭音频输入

    Returns boolean

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

startAudioOutput

  • startAudioOutput(mediaStream, userId): boolean

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

    Parameters

    • mediaStream: MediaStream

      音频流对象

    • userId: string

      用户ID

    Returns boolean

    • true: 打开音频输出成功
    • false: 打开音频输出失败

stopAudioOutput

  • stopAudioOutput(userId?): boolean

  • 关闭音频输出

    Parameters

    • Optional userId: string

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

    Returns boolean

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

switchCamera

  • switchCamera(camera?): Promise<boolean>

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

    Parameters

    Returns Promise<boolean>

    Promise

    Note

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

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

onVisibilityChange

  • onVisibilityChange(ev): void

  • Parameters

    • ev: any

    Returns void

isCameraOpen

  • isCameraOpen(): boolean

  • 摄像头是否打开

    Returns boolean

    摄像头是否打开

getCurrentCamera

getCameras

isAudioStart

  • isAudioStart(): boolean

  • 音频设备是否打开

    Returns boolean

    音频设备是否打开

设置

主题

Generated using TypeDoc