agora::rtc::ILocalVideoTrack类 参考

  • C++

更新时间

继承自 agora::rtc::IVideoTrack.

详细描述

ILocalVideoTrack 类提供本地视频轨道的基本方法。

你可以通过 publishVideo 方法发布一个或多个视频轨道。

构造及析构函数说明

~ILocalVideoTrack()

inline
protected
agora::rtc::ILocalVideoTrack::~ILocalVideoTrack()

成员函数说明

setEnabled()

pure
virtual
virtual void agora::rtc::ILocalVideoTrack::setEnabled(bool enable, aosl_ref_t ares = AOSL_REF_INVALID)

开启或关闭本地视频轨道。

本地视频轨道开启之后,SDK 可以对采集、处理和编码本地视频。

参数
参数名描述
enable

开启或关闭本地视频轨道。

  • true: 开启本地视频轨道。
  • false: 关闭本地视频轨道。
ares

用于 SDK 的生命周期保护,填写默认值即可。

表格内容超出当前宽度,可横向滚动查看更多列。

setVideoEncoderConfiguration()

pure
virtual
virtual int agora::rtc::ILocalVideoTrack::setVideoEncoderConfiguration(const VideoEncoderConfiguration & config, aosl_ref_t ares = AOSL_REF_INVALID)

设置视频编码属性。

参数
参数名描述
config

视频编码参数配置。详见 VideoEncoderConfiguration 。

ares

用于 SDK 的生命周期保护,填写默认值即可。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。

setSimulcastStreamMode()

pure
virtual
virtual int agora::rtc::ILocalVideoTrack::setSimulcastStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastConfigInternal & config, aosl_ref_t ares = AOSL_REF_INVALID)

在发送端设置双流模式并设置视频小流。

参数
参数名描述
mode

发送视频流的模式。详见 SIMULCAST_STREAM_MODE 。

config

视频小流的配置。详见 SimulcastConfigInternal 。当设置 mode 参数为 DISABLE_SIMULCAST_STREAM 时,config 参数不会生效。

ares

用于 SDK 的生命周期保护,填写默认值即可。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。

getState()

pure
virtual
virtual LOCAL_VIDEO_STREAM_STATE agora::rtc::ILocalVideoTrack::getState()

获取本地视频流状态。

返回值

本地视频流状态: LOCAL_VIDEO_STREAM_STATE 。

getStatistics()

pure
virtual
virtual bool agora::rtc::ILocalVideoTrack::getStatistics(LocalVideoTrackStats & stats)

获取本地视频轨道的统计信息。

参数
参数名描述
stats
[out]

统计信息: LocalVideoTrackStats。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。

registerVideoMetadataObserver()

inline
virtual
virtual int agora::rtc::ILocalVideoTrack::registerVideoMetadataObserver(IMetadataObserver * metadataObserver, aosl_ref_t ares = AOSL_REF_INVALID)

注册视频 Metadata 观测器,用于发送和接收视频附属信息。

自从

4.4.33

参数
参数名描述
metadataObserver

Metadata 观测器:IMetadataObserver。

ares

异步操作引用,默认值为 AOSL_REF_INVALID。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

0:成功;小于 0:失败。

unregisterVideoMetadataObserver()

inline
virtual
virtual int agora::rtc::ILocalVideoTrack::unregisterVideoMetadataObserver(IMetadataObserver * metadataObserver)

注销视频 Metadata 观测器。

自从

4.4.33

参数
参数名描述
metadataObserver

要注销的 Metadata 观测器。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

0:成功;小于 0:失败。