|
Agora RTC Objective-C API Reference
Refactor
|
Inherits IVideoTrack.
Public Member Functions | |
| virtual int | setEnabled (bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | setVideoEncoderConfiguration (const VideoEncoderConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | setSimulcastStreamMode (SIMULCAST_STREAM_MODE mode, const SimulcastConfigInternal &config, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual LOCAL_VIDEO_STREAM_STATE | getState ()=0 |
| virtual bool | getStatistics (LocalVideoTrackStats &stats)=0 |
| virtual VideoTrackType | getType () OPTIONAL_OVERRIDE |
| virtual bool | addVideoFilter (agora_refptr< IVideoFilter > filter, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER, const char *id=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual bool | removeVideoFilter (agora_refptr< IVideoFilter > filter, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER, const char *id=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual bool | hasVideoFilter (const char *id, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER)=0 |
| virtual bool | addRenderer (agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual bool | removeRenderer (agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | enableVideoFilter (const char *id, bool enable, aosl_ref_t ares=AOSL_REF_INVALID) |
| virtual int | setFilterProperty (const char *id, const char *key, const char *json_value, aosl_ref_t ares=AOSL_REF_INVALID) |
| virtual int | getFilterProperty (const char *id, const char *key, char *json_value, size_t buf_size, aosl_ref_t ares=AOSL_REF_INVALID) |
| virtual int | registerVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *encodedObserver, aosl_ref_t ares=AOSL_REF_INVALID) |
| virtual int | unregisterVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *encodedObserver) |
ILocalVideoTrack is the basic class for local video tracks, providing the main methods of local video tracks. You can create a local video track by calling one of the following methods:
createCameraVideoTrackcreateScreenVideoTrackcreateMixedVideoTrackcreateCustomVideoTrackcreateMediaPlayerVideoTrackAfter creating local video tracks, you can publish one or more local video tracks by calling publishVideo.
|
inlineprotected |
|
pure virtual |
Enables or disables the local video track.
Once the local video track is enabled, the SDK allows for local video capturing, processing, and encoding.
| enable | Determines whether to enable the local video track.
|
|
pure virtual |
Sets the video encoder configuration.
Each video encoder configuration corresponds to a set of video parameters, including the resolution, frame rate, bitrate, and video orientation.
The configurations specified in this method are the maximum values under ideal network conditions. If the video engine cannot render the video using the specified parameters due to poor network conditions, the configurations further down the list are considered until a successful configuration is found.
| config | The reference to the video encoder configuration. See VideoEncoderConfiguration. |
|
pure virtual |
Set simulcast stream mode, enable, disable or auto enable
| mode | Determines simulcast stream mode. See SIMULCAST_STREAM_MODE. |
| config | The reference to the configurations for the simulcast stream mode. See SimulcastStreamConfig. |
|
pure virtual |
Gets the state of the local video stream.
|
pure virtual |
Gets the statistics of the local video track.
| [out] | stats | The reference to the statistics of the local video track. |
true: Success.false: Failure.
|
inlinevirtual |
|
pure virtualinherited |
Adds a video filter to the video track.
Add a video filter in either of the following ways:
To add multiple filters, call this method multiple times. The order of the added filters depends on when the app successfully adds the filter.
| filter | The video filter that you want to add to the video track. |
| position | The position where the filter is added. |
| id | id of the filter |
true: The video filter is added successfully.false: The video filter fails to be added.
|
pure virtualinherited |
Removes the video filter added by addVideoFilter from the video track.
| filter | The video filter that you want to remove: IVideoFilter. |
| position | The position of the filter. @id id of the filter |
true: The video filter is removed successfully.false: The video filter fails to be removed.
|
pure virtualinherited |
Whether a video filter exists
| id | id of the filter |
|
pure virtualinherited |
Adds a video renderer to the video track.
Add a video renderer in either of the following ways:
IVideoRenderer in the IMediaNodeFactory class.IVideoSinkBase class.| videoRenderer | The video renderer that you want to add: IVideoSinkBase. |
| position | The position where the renderer is added. |
true: The video renderer is added successfully.false: The video renderer fails to be added.
|
pure virtualinherited |
Removes the video renderer added by addRenderer from the video track.
| videoRenderer | The video renderer that you want to remove: IVideoSinkBase. |
| position | The position where the renderer is removed: VIDEO_MODULE_POSITION. |
true: The video renderer is removed successfully.false: The video renderer fails to be removed.
|
inlinevirtualinherited |
Enable / Disable specified video filter
| id | id of the filter |
| enable | enable / disable the filter with given id |
|
inlinevirtualinherited |
set the properties of the specified video filter
| id | id of the filter |
| key | key of the property |
| json_value | json str value of the property |
|
inlinevirtualinherited |
get the properties of the specified video filter
| id | id of the filter |
| key | key of the property |
| json_value | json str value of the property |
|
inlinevirtualinherited |
Registers an IVideoEncodedFrameObserver object.
You need to implement the IVideoEncodedFrameObserver class in this method. Once you successfully register the encoded image receiver, the SDK triggers the onEncodedVideoFrameReceived callback when it receives the encoded video image.
| encodedObserver | The pointer to the IVideoEncodedFrameObserver object. |
|
inlinevirtualinherited |
Releases the IVideoEncodedFrameObserver object.
| encodedObserver | The pointer to the IVideoEncodedFrameObserver object. |
|
pure virtualinherited |
|
pure virtualinherited |
|
pure virtualinherited |