Hierarchy

基本方法 Methods

  • 给预览画面指定一个 DOM 容器,SDK 将会在这个元素中生成 VIDEO 元素并播放预览画面

    Returns

    生成的 VIDEO 元素

    Example

    // <div id="container"></div>
    const video = rtsClient.setRenderView('container');

    Parameters

    • containerId: string

      容器 HTML 元素的 ID

    Returns undefined | HTMLMediaElement

  • 设置推流视频质量

    Example

    rtsClient.setVideoQuality('720p_2');
    

    Parameters

    • profile: string

      预定义的模板名称,例如 720_1,具体可选配置请参考 VideoProfileMap(您可以遍历查看出键值对的内容,key 就是 setVideoQuality 需要的参数,value 就是对应的详细配置)。如果不设置,默认值是 720p_2

    Returns void

  • 开启摄像头采集,捕获一个视频流

    Returns

    获取到的视频流 streamId

    Example

    const streamId = await rtsClient.startCamera();
    

    Parameters

    • Optional deviceId: string

      可以指定输入设备 ID

    Returns Promise<undefined | string>

  • 开启麦克风采集,捕获一个音频流

    Returns

    获取到的音频流 streamId

    Example

    const streamId = await rtsClient.startMicrophone();
    

    Parameters

    • Optional deviceId: string

      可以指定输入设备 ID

    Returns Promise<undefined | string>

  • 开始推流

    Example

    await rtsClient.startPush();
    

    Parameters

    • url: string

      推流地址,例如:artc://推流域名/appname/streamname

    • Optional config: IPublishConfig

      可选配置

    Returns Promise<any>

  • 开始屏幕采集

    Example

    const streamId = await rtsClient.startScreenCapture();
    

    Parameters

    Returns Promise<undefined | string>

高级方法 Methods

  • 添加一路自定义的音视频流,用户可以传入自己采集的音视频流

    Returns

    自定义流id

    Parameters

    • stream: MediaStream

      自定义流

    Returns Promise<string>

  • 禁用音频流

    注:禁用音频流不会关闭麦克风,但是会停止向远端推送音频流。

    Example

    rtsClient.disableAudio();
    

    Returns void

  • 禁用视频流

    注:禁用视频流不会关闭摄像头或屏幕共享,但是会停止向远端推送视频流。

    Example

    rtsClient.disableVideo();
    

    Returns void

  • 销毁推流实例

    Example

    rtsClient.dispose();
    

    Returns void

  • 恢复禁用的音频流

    Example

    rtsClient.enableAudio();
    

    Returns void

  • 恢复禁用的视频流

    Example

    rtsClient.enableVideo();
    

    Returns void

  • 获取设备管理对象

    Example

    const deviceManager = rtsClient.getDeviceManager();
    

    Returns DeviceManager

  • 获取本地预览的流,这个流就是要推送到远端的流

    Example

    const stream = rtsClient.getPublishStream();
    

    Returns undefined | MediaStream

  • 获取采集到的原始流,摄像头、麦克风或屏幕共享流

    Example

    const stream = rtsClient.getSourceStream('xxxx');
    

    Parameters

    • sourceStreamId: string

      streamId

    Returns undefined | MediaStream

  • 移除自定义流

    Parameters

    Returns void

  • 停止摄像头采集,如果不传入 streamId,则停止所有的摄像头

    Example

    rtsClient.stopCamera();
    

    Parameters

    • Optional streamId: string

      需要停止的视频流 streamId

    Returns void

  • 停止麦克风采集,如果不传入 streamId,则停止所有的麦克风

    Example

    rtsClient.stopMicrophone();
    

    Parameters

    • Optional streamId: string

      需要停止的音频流 streamId

    Returns void

  • 停止推流

    Example

    rtsClient.stopPush();
    

    Returns void

  • 停止屏幕采集 如果不传入 streamId,则停止所有的屏幕

    Example

    rtsClient.stopScreenCapture();
    

    Parameters

    • Optional streamId: string

      需要停止的屏幕流id

    Returns void