Class JRTCMediaDevice

Hierarchy

Methods

isCameraOpen getCurrentCamera getCameras isAudioStart setCameraProperty create destroy startCameraVideo startVideo stopVideo startAudioOutput stopAudioOutput stopAllMedia switchCamera enableSpeaker isSpeakerOn

Methods

isCameraOpen

  • isCameraOpen(): boolean

  • 摄像头是否打开

    Returns boolean

    摄像头是否打开

getCurrentCamera

getCameras

isAudioStart

  • isAudioStart(): boolean

  • 音频设备是否打开

    Returns boolean

    音频设备是否打开

setCameraProperty

  • setCameraProperty(width, height, frameRate): void

  • 设置摄像头采集属性

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

    Parameters

    • width: number

      采集宽度，默认为 640

    • height: number

      采集高度，默认为 360

    • frameRate: number

      采集帧速率，默认为 24

    Returns void

    Note

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

Static create

  • create(callback, initParam): undefined | JRTCMediaDevice

  • 创建 JRTCMediaDevice 对象

    Parameters

    Returns undefined | JRTCMediaDevice

    JRTCMediaDevice 对象

    Note

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

    Throws

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

Static destroy

  • destroy(): void

  • 销毁 JRTCMediaDevice 对象

    Returns void

    Note

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

startCameraVideo

  • startCameraVideo(renderType, viewId, pageTarget, enableMic?): Promise<JRTCMediaDeviceVideoCanvas>

  • 开始本端视频渲染

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

    Parameters

    • renderType: RenderType

      视频渲染模式

    • viewId: string

      本端视频视图组件（local-stream）id

    • pageTarget: TrivialInstance

      页面节点

    • Optional enableMic: boolean

      是否打开麦克风，默认打开

    Returns Promise<JRTCMediaDeviceVideoCanvas>

    Promise

startVideo

  • startVideo(streamUrl, renderType, viewId, pageTarget): undefined | JRTCMediaDeviceVideoCanvas

  • 开始远端视频渲染

    Parameters

    • streamUrl: string

      远端视频拉流地址

    • renderType: RenderType

      视频渲染模式

    • viewId: string

      视频视图组件（remote-stream）id

    • pageTarget: TrivialInstance

      页面节点

    Returns undefined | JRTCMediaDeviceVideoCanvas

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

stopVideo

startAudioOutput

  • startAudioOutput(): boolean

  • 打开音频输出（远端音频）

    Returns boolean

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

stopAudioOutput

  • stopAudioOutput(): boolean

  • 关闭音频输出（远端音频）

    Returns boolean

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

stopAllMedia

  • stopAllMedia(): void

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

    Returns void

switchCamera

  • switchCamera(): boolean

  • 切换摄像头

    Returns boolean

    • true: 切换摄像头成功
    • false: 切换摄像头失败

    Note

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

    • 调用此方法时要保证摄像头已打开，否则将直接返回 false
    • 设备拥有两个以上摄像头，否则将直接返回 false

enableSpeaker

  • enableSpeaker(enable): void

  • 开启/关闭扬声器

    只有在音频已经启动的情况下调用才会生效

    Parameters

    • enable: boolean

      开启或关闭扬声器

      • true: 开启
      • false: 关闭

    Returns void

isSpeakerOn

  • isSpeakerOn(): boolean

  • 是否开启扬声器

    Returns boolean

    是否开启扬声器

设置

主题

Generated using TypeDoc