agora::rtc::ILocalVideoTrack类 参考

abstract

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

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

构造及析构函数说明

~ILocalVideoTrack()

agora::rtc::ILocalVideoTrack::~ILocalVideoTrack ( )

成员函数说明

getState()

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

获取本地视频流状态。

返回值

本地视频流状态： LOCAL_VIDEO_STREAM_STATE 。

getStatistics()

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

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

参数

参数名	描述
stats [out]	统计信息： LocalVideoTrackStats。

返回值

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

setEnabled()

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

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

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

参数

参数名	描述
enable	开启或关闭本地视频轨道。 true: 开启本地视频轨道。 false: 关闭本地视频轨道。
ares	用于 SDK 的生命周期保护，填写默认值即可。

setSimulcastStreamMode()

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: 方法调用失败。

setVideoEncoderConfiguration()

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

设置视频编码属性。

参数

参数名	描述
config	视频编码参数配置。详见 VideoEncoderConfiguration 。
ares	用于 SDK 的生命周期保护，填写默认值即可。

返回值

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