Tencent Cloud LiteAV SDK

https://liteav.sdk.qcloud.com/doc/api/en/
Admin
Tencent Cloud LiteAV SDK is a suite of high-availability components for real-time audio/video, live...
Tokens:198,010
Snippets:2,313
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start Publishing to CDN

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Demonstrates the sequence of initializing the TRTC instance, entering a room, starting local media, and initiating a CDN stream push.

```objective-c
TRTCCloud *trtcCloud = [TRTCCloud sharedInstance];
[trtcCloud enterRoom:params appScene:TRTCAppSceneLIVE];
[trtcCloud startLocalPreview:frontCamera view:localView];
[trtcCloud startLocalAudio];
[trtcCloud startPublishing: "user_stream_001" type:TRTCVideoStreamTypeBig];
```

--------------------------------

### startPlay()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePlayer__cplusplus.html

Starts playing the audio and video streams.

```APIDOC
## startPlay()

### Description
Starts playing the audio and video streams. The RTMP, HTTP-FLV and TRTC streaming protocols are supported.

### Parameters
- **url** (const char*) - Required - URL of the audio and video streams to be played.

### Returns
- **int32_t** - Return code V2TXLiveCode (V2TXLIVE_OK, V2TXLIVE_ERROR_INVALID_PARAMETER, V2TXLIVE_ERROR_REFUSED).
```

--------------------------------

### startPreload

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPreloadManager__android.html

Starts a video predownload task.

```APIDOC
## int startPreload(final String url, final int preloadSizeMB, final long preferredResolution, final ITXVodPreloadListener listener)

### Description
This API is used to start predownloading. Note: Ensure global cache settings are configured before calling this method.

### Parameters
- **url** (String) - The predownload URL.
- **preloadSizeMB** (int) - The size of the data to be predownloaded in MB.
- **preferredResolution** (long) - The preferred resolution (e.g., TXVodPlayConfig.VIDEO_RESOLUTION_720X1280 or -1).
- **listener** (ITXVodPreloadListener) - The callback for predownload events.

### Returns
- **int** - The task ID, used to stop the predownloading task.
```

--------------------------------

### startPreload:preloadSize:preferredResolution:delegate:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPreloadManager__ios.html

Starts a video predownload task.

```APIDOC
## - (int)startPreload:(NSString *)requestURL preloadSize:(int)preloadSizeMB preferredResolution:(long)preferredResolution delegate:(id<TXVodPreloadManagerDelegate>)delegate

### Description
This API is used to start predownloading. Ensure the player engine cache directory and size are set globally before calling this method.

### Parameters
- **requestURL** (NSString *) - The predownload URL
- **preloadSizeMB** (int) - The size of the data to be predownloaded in MB
- **preferredResolution** (long) - The preferred resolution. Pass -1 if not needed.
- **delegate** (id<TXVodPreloadManagerDelegate>) - The callback delegate

### Returns
- **int** - The task ID, used to stop the predownload.
```

--------------------------------

### startLivePlay:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePlayer__ios.html

Starts playing the audio and video streams.

```APIDOC
## startLivePlay:(NSString *)url

### Description
Starts playing the audio and video streams. Note: Starting from version 10.7, a valid Licence must be set globally before playback.

### Parameters
- **url** (NSString *) - Required - URL of the audio and video streams to be played. Supports RTMP, HTTP-FLV, and TRTC protocols.

### Returns
- **V2TXLiveCode** - V2TXLIVE_OK: success; V2TXLIVE_ERROR_INVALID_PARAMETER: invalid URL; V2TXLIVE_ERROR_REFUSED: duplicate streamId; TXLIVE_ERROR_INVALID_LICENSE: invalid licence.
```

--------------------------------

### startPush()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePusher__cplusplus.html

Starts pushing audio and video data to the specified URL.

```APIDOC
## int32_t startPush(const char * url)

### Description
Starts pushing the audio and video data.

### Parameters
- **url** (const char *) - Push URL, which can be any push server.

### Returns
- **V2TXLIVE_OK**: Operation succeeded.
- **V2TXLIVE_ERROR_INVALID_PARAMETER**: Operation failed. The URL is invalid.
- **V2TXLIVE_ERROR_INVALID_LICENSE**: Operation failed. The license is invalid and authentication failed.
- **V2TXLIVE_ERROR_REFUSED**: Operation failed. Duplicate streamId.
```

--------------------------------

### startVodPlay:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__ios.html

Starts video playback from a specified URL.

```APIDOC
## startVodPlay:(NSString *)url

### Description
Starts playback of the video stream from the provided URL. Note: Requires a valid Licence set via TXLiveBase#setLicence (v10.7+).

### Parameters
- **url** (NSString *) - Required - The URL of the stream to be played.

### Returns
- **int** - 0 if playback started successfully, -1 otherwise.
```

--------------------------------

### onDownloadStart(TXVodDownloadMediaInfo mediaInfo)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__ITXVodDownloadListener__android.html

Triggered when the download process starts.

```APIDOC
## void onDownloadStart(TXVodDownloadMediaInfo mediaInfo)

### Description
Called when the video download process has started.

### Parameters
- **mediaInfo** (TXVodDownloadMediaInfo) - The download object.
```

--------------------------------

### startMicDeviceTest

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXDeviceManager__cplusplus.html

Starts microphone testing to verify functionality.

```APIDOC
## startMicDeviceTest

### Description
Tests whether the microphone is functioning properly by returning volume levels via callback.

### Parameters
- **interval** (uint32_t) - Required - The interval in milliseconds for volume callbacks.
```

--------------------------------

### startAudioRecording:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Starts recording local and remote audio streams into a local file.

```APIDOC
## startAudioRecording:(TRTCAudioRecordingParams *)

### Description
Starts recording local and remote audio streams (such as local audio, remote audio, background music, and sound effects) into a local file. This API can be called before or after room entry.

### Parameters
- **param** (TRTCAudioRecordingParams) - Required - Recording configuration parameters.

### Returns
- **int** - 0: success; -1: audio recording has been started; -2: failed to create file or directory; -3: the audio format of the specified file extension is not supported.
```

--------------------------------

### startPlayMusic

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXAudioEffectManager__android.html

Starts background music playback.

```APIDOC
## boolean startPlayMusic(final AudioMusicParam musicParam)

### Description
Starts background music playback. Each music track must have an ID to manage playback state.

### Parameters
- **musicParam** (AudioMusicParam) - Required - The music configuration parameters.
```

--------------------------------

### setStartTime()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Sets the playback start time.

```APIDOC
## void setStartTime(float pos)

### Description
This API is used to set the playback start time.

### Parameters
- **pos** (float) - The video stream time point in seconds, accurate down to three decimal places.
```

--------------------------------

### onStart

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXAudioEffectManager__cplusplus.html

Callback triggered when background music playback starts.

```APIDOC
## onStart(int id, int errCode)

### Description
Triggered when the background music playback starts.

### Parameters
- **id** (int) - The ID of the music track.
- **errCode** (int) - The error code associated with the start event.
```

--------------------------------

### startPublishing

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Starts publishing audio/video streams to the Tencent Cloud CSS CDN.

```APIDOC
## virtual void startPublishing(const char *streamId, TRTCVideoStreamType streamType)

### Description
Requests the TRTC server to relay the current user's audio/video streams to the Tencent Cloud CSS CDN. Requires 'Enable Relayed Push' to be enabled in the TRTC console.

### Parameters
- **streamId** (const char *) - Required - Custom stream ID for the live stream.
- **streamType** (TRTCVideoStreamType) - Required - The video stream type (TRTCVideoStreamTypeBig or TRTCVideoStreamTypeSub).
```

--------------------------------

### startVodPlayWithParams:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__ios.html

Starts video playback using authentication parameters and file ID.

```APIDOC
## startVodPlayWithParams:(TXPlayerAuthParams *)params

### Description
Initiates playback for a file identified by its file ID using authentication parameters. Note: Requires a valid Licence set via TXLiveBase#setLicence (v10.7+).

### Parameters
- **params** (TXPlayerAuthParams *) - Required - The authentication parameters for the playback request.
```

--------------------------------

### startPush(String url)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePusher__android.html

Starts pushing audio and video data to the specified URL.

```APIDOC
## startPush(String url)

### Description
Starts pushing the audio and video data to the provided push URL.

### Parameters
- **url** (String) - Required - The push URL for the target server.

### Returns
- **int** - Return code for V2TXLiveCode (V2TXLIVE_OK: success, V2TXLIVE_ERROR_INVALID_PARAMETER: invalid URL, V2TXLIVE_ERROR_INVALID_LICENSE: invalid license, V2TXLIVE_ERROR_REFUSED: duplicate streamId)
```

--------------------------------

### startLocalRecording

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Starts recording the audio/video content during a live session into a local file.

```APIDOC
## virtual void startLocalRecording(const TRTCLocalRecordingParams &params)

### Description
Starts recording the audio/video content during live streaming into a local file.

### Parameters
- **params** (TRTCLocalRecordingParams) - Required - Recording parameter configuration.
```

--------------------------------

### startPush:(NSString *)url

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePusher__ios.html

Starts pushing the audio and video data to the specified URL.

```APIDOC
## startPush:(NSString *)url

### Description
Starts pushing the audio and video data.

### Parameters
- **url** (NSString *) - Required - Push URL, which can be any push server.

### Returns
- **V2TXLiveCode** - V2TXLIVE_OK (success), V2TXLIVE_ERROR_INVALID_PARAMETER (invalid URL), V2TXLIVE_ERROR_INVALID_LICENSE (invalid license), V2TXLIVE_ERROR_REFUSED (duplicate streamId).
```

--------------------------------

### setStartTime:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__ios.html

Sets the starting time point for video playback.

```APIDOC
## setStartTime:(CGFloat)startTime

### Description
Sets the playback start time in seconds, accurate to three decimal places.

### Parameters
- **startTime** (CGFloat) - The start time in seconds.
```

--------------------------------

### startPush:(NSString *)url

Source: https://liteav.sdk.qcloud.com/doc/api/en/interfaceV2TXLivePusher.html

Starts pushing audio and video data to the specified URL.

```APIDOC
## startPush:(NSString *)url

### Description
Starts pushing the audio and video data.

### Parameters
- **url** (NSString *) - Required - Push URL, which can be any push server.

### Returns
- **V2TXLiveCode** - Returns V2TXLIVE_OK for success, or error codes V2TXLIVE_ERROR_INVALID_PARAMETER, V2TXLIVE_ERROR_INVALID_LICENSE, or V2TXLIVE_ERROR_REFUSED.
```

--------------------------------

### setAutoPlay()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Configures whether the player starts automatically.

```APIDOC
## void setAutoPlay(boolean autoPlay)

### Description
This API is used to set whether to start VOD automatically after call of startPlay. VOD starts automatically by default.

### Parameters
- **autoPlay** (boolean) - Whether to enable auto-play.
```

--------------------------------

### onScreenCaptureStarted

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloudListener__android.html

Callback triggered when screen sharing starts.

```APIDOC
## void onScreenCaptureStarted()

### Description
Triggered when the SDK starts screen sharing after calling startScreenCapture.
```

--------------------------------

### startLocalPreview(boolean frontCamera, TXCloudVideoView view)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__android.html

Enables the local camera preview. If called before enterRoom, it prepares the camera; if called after, it starts pushing the video stream.

```APIDOC
## startLocalPreview(boolean frontCamera, TXCloudVideoView view)

### Description
Enable the preview image of local camera. If called before enterRoom, the SDK will only enable the camera and wait until enterRoom is called before starting push. If called after enterRoom, the SDK will enable the camera and automatically start pushing the video stream.

### Parameters
- **frontCamera** (boolean) - true: front camera; false: rear camera
- **view** (TXCloudVideoView) - Control that carries the video image
```

--------------------------------

### startPlayDrm:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__ios.html

Starts playback of a file encrypted with standard FairPlay DRM.

```APIDOC
## startPlayDrm:(TXPlayerDrmBuilder *)drmBuilder

### Description
Initiates playback for content encrypted with FairPlay DRM using the provided builder configuration.

### Parameters
- **drmBuilder** (TXPlayerDrmBuilder *) - Required - The DRM playback configuration object.

### Returns
- **int** - 0 if playback started successfully, -1 otherwise.
```

--------------------------------

### startPublishCDNStream

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Starts publishing audio/video streams to a non-Tencent Cloud CDN.

```APIDOC
## virtual void startPublishCDNStream(const TRTCPublishCDNParam &param)

### Description
Relays audio/video streams to live streaming CDN services of other cloud providers. Note that this may incur additional relaying bandwidth fees.

### Parameters
- **param** (TRTCPublishCDNParam) - Required - CDN relaying configuration.
```

--------------------------------

### onAudioPlaying:firstPlay:extraInfo:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePlayerObserver__ios.html

Callback triggered when audio playback starts.

```APIDOC
## - (void)onAudioPlaying:(id<V2TXLivePlayer>)player firstPlay:(BOOL)firstPlay extraInfo:(NSDictionary *)extraInfo

### Description
Audio playback event.

### Parameters
- **player** (id<V2TXLivePlayer>) - Required - Player object that calls back this notification.
- **firstPlay** (BOOL) - Required - Play for the first time.
- **extraInfo** (NSDictionary *) - Required - Extended information.
```

--------------------------------

### startVodPlay(TXPlayInfoParams playInfoParams)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Starts playback using fileId parameters. Note that a valid Licence must be set via TXLiveBase#setLicence before playback.

```APIDOC
### Method
void startVodPlay(TXPlayInfoParams playInfoParams)

### Description
Starts playback through fileId. Starting from version 10.7, the Licence must be set through TXLiveBase#setLicence globally before playback can succeed.

### Parameters
- **playInfoParams** (TXPlayInfoParams) - Required - Parameters for playback through fileId.
```

--------------------------------

### startScreenCaptureByReplaykit:encParam:appGroup:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Starts system-level screen sharing with support for stream types.

```APIDOC
## - (void)startScreenCaptureByReplaykit:(TRTCVideoStreamType)streamType encParam:(TRTCVideoEncParam *)encParams appGroup:(NSString *)appGroup

### Description
Starts system-level screen sharing for iOS 11.0 and above. This method allows capturing the entire system screen and requires a ReplayKit extension module.

### Parameters
- **streamType** (TRTCVideoStreamType) - Required - Channel used for screen sharing (primary or substream).
- **encParams** (TRTCVideoEncParam *) - Required - Video encoding parameters. If nil, uses previously set parameters.
- **appGroup** (NSString *) - Required - Application Group Identifier shared by the app and the screen sharing process.
```

--------------------------------

### onCameraDidReady

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloudListener__android.html

Callback triggered when the camera has successfully started and is ready for use.

```APIDOC
## onCameraDidReady()

### Description
Triggered after calling startLocalPreview when the camera is successfully initialized. If the camera fails to start, an onError callback will be triggered instead.
```

--------------------------------

### startScreenCapture()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Starts desktop screen sharing, allowing the user to capture screen content or a specific application window.

```APIDOC
## virtual void startScreenCapture(TXView view, TRTCVideoStreamType streamType, TRTCVideoEncParam * encParam)

### Description
Starts desktop screen sharing. This API can capture the screen content or a specified application (desktop only) and share it with other users in the same room.

### Parameters
- **view** (TXView) - Parent control of the rendering control, which can be set to a null value, indicating not to display the preview of the shared screen (desktop only).
- **streamType** (TRTCVideoStreamType) - Channel used for screen sharing, which can be the primary stream (TRTCVideoStreamTypeBig) or substream (TRTCVideoStreamTypeSub).
- **encParam** (TRTCVideoEncParam*) - Image encoding parameters used for screen sharing, which can be set to nil to let the SDK choose optimal parameters.
```

--------------------------------

### startPlayMusic:onStart:onProgress:onComplete:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXAudioEffectManager__ios.html

Starts background music playback with specified parameters and callback blocks.

```APIDOC
## startPlayMusic:(TXAudioMusicParam *)musicParam onStart:(TXAudioMusicStartBlock)startBlock onProgress:(TXAudioMusicProgressBlock)progressBlock onComplete:(TXAudioMusicCompleteBlock)completeBlock

### Description
Starts background music. Each music track must be assigned an ID to manage playback. If the same ID is used for a new track, the current one will stop.

### Parameters
- **musicParam** (TXAudioMusicParam *) - Required - Music configuration parameters
- **startBlock** (TXAudioMusicStartBlock) - Optional - Callback for music start
- **progressBlock** (TXAudioMusicProgressBlock) - Optional - Callback for playback progress
- **completeBlock** (TXAudioMusicCompleteBlock) - Optional - Callback for music completion
```

--------------------------------

### Set Watermark Example

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePusher__cplusplus.html

Demonstrates how to set a watermark image on iOS/macOS and Android platforms.

```cpp
self.pusher->setWatermark("imageName", 0.1, 0.1, 0.2);
```

```cpp
self.pusher->setWatermark("imageName.png", 0.1, 0.1, 0.2);
```

--------------------------------

### Rendering Control Usage in QT

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloudDef__cplusplus.html

Example of using a QWidget window ID as a TXView for local video preview.

```cpp
QWidget *videoView;
// The relevant code for setting the videoView is omitted here...
getTRTCShareInstance()->startLocalPreview(reinterpret_cast<TXView>(videoView->winId()));
```

--------------------------------

### startAudioRecording(const TRTCAudioRecordingParams &param)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Starts audio recording to a local file. This method can be called before or after room entry.

```APIDOC
## startAudioRecording

### Description
Starts audio recording. The SDK will selectively record local and remote audio streams into a local file.

### Parameters
- **param** (TRTCAudioRecordingParams) - Required - Recording configuration parameters.

### Returns
- **int** - 0: success; -1: already started; -2: failed to create file; -3: unsupported format.
```

--------------------------------

### startScreenCapture:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Starts screen sharing. Note: This API is deprecated since v7.2.

```APIDOC
## startScreenCapture:

### Description
Start screen sharing. This API is not recommended after v7.2. Please use startScreenCapture:streamType:encParam: instead.

### Signature
- (void) startScreenCapture:(NSView *)view;
```

--------------------------------

### startAudioRecording(TRTCCloudDef.TRTCAudioRecordingParams param)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__android.html

Starts recording local and remote audio streams into a local file.

```APIDOC
## startAudioRecording(TRTCCloudDef.TRTCAudioRecordingParams param)

### Description
Starts recording local and remote audio streams (such as local audio, remote audio, background music, and sound effects) into a local file. This can be called before or after room entry.

### Parameters
- **param** (TRTCCloudDef.TRTCAudioRecordingParams) - Required - Recording configuration parameters.

### Returns
- **int** - 0: success; -1: audio recording has been started; -2: failed to create file or directory; -3: the audio format of the specified file extension is not supported.
```

--------------------------------

### startSpeakerDeviceTest

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXDeviceManager__cplusplus.html

Starts the speaker testing process by playing a specified audio file to verify playback functionality.

```APIDOC
## startSpeakerDeviceTest(const char * filePath)

### Description
Starts the speaker testing process. This is used to verify if the audio playback device is functioning correctly by playing a specified audio file.

### Parameters
- **filePath** (const char *) - The file path of the audio file to be played for the test.
```

--------------------------------

### startSpeedTest()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Starts a network speed test to evaluate connection quality before entering a room.

```APIDOC
## virtual int startSpeedTest(const TRTCSpeedTestParams & params)

### Description
Starts a network speed test. This should be performed before room entry to avoid interference with audio/video transfer.

### Parameters
- **params** (TRTCSpeedTestParams) - Speed test options.

### Returns
- **int** - Interface call result, <0 indicates failure.
```

--------------------------------

### startLocalRecording(TRTCCloudDef.TRTCLocalRecordingParams params)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__android.html

Starts recording the audio/video content during live streaming into a local file.

```APIDOC
## startLocalRecording(TRTCCloudDef.TRTCLocalRecordingParams params)

### Description
Start local media recording. This API records the audio/video content during live streaming into a local file.

### Parameters
- **params** (TRTCCloudDef.TRTCLocalRecordingParams) - Recording parameter.
```

--------------------------------

### startScreenCaptureByReplaykit:appGroup:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Starts system-level screen sharing. Note: This method is deprecated since v8.6.

```APIDOC
## - (void)startScreenCaptureByReplaykit:(TRTCVideoEncParam *)encParams appGroup:(NSString *)appGroup

### Description
Starts system-level screen sharing for iOS 11.0 and above. This method is deprecated; please use the newer version with streamType support.

### Parameters
- **encParams** (TRTCVideoEncParam *) - Required - Video encoding parameters.
- **appGroup** (NSString *) - Required - Application Group Identifier shared by the app and the screen sharing process.
```

--------------------------------

### startVodPlay(TXPlayerAuthBuilder authBuilder)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Starts video playback using an authentication builder. This method is deprecated.

```APIDOC
## int startVodPlay(TXPlayerAuthBuilder authBuilder)

### Description
This method is used to start playback through a fileId using an authBuilder. This method is deprecated; it is recommended to use startPlay(TXPlayInfoParams) instead.

### Parameters
- **authBuilder** (TXPlayerAuthBuilder) - The authentication builder object.

### Returns
- **int** - Returns whether playback started successfully.
```

--------------------------------

### startPlayMusic()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXAudioEffectManager__cplusplus.html

Starts background music playback. You must assign an ID to each music track to manage it later.

```APIDOC
## virtual void startPlayMusic(AudioMusicParam musicParam)

### Description
Starts background music. You must assign an ID to each music track so that you can start, stop, or set the volume of music tracks by ID.

### Parameters
- **musicParam** (AudioMusicParam) - Music parameter containing ID and file information.

### Attention
1. If you play the same music track multiple times, please use the same ID.
2. If you want to play different music tracks at the same time, use different IDs.
3. If you use the same ID to play a music track different from the current one, the SDK will stop the current one before playing the new one.
```

--------------------------------

### getHeight()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Gets the height of the video.

```APIDOC
## getHeight()

### Description
The video height.

### Returns
- **int** - The height of the video.
```

--------------------------------

### startDownload()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodDownloadManager__android.html

Initiates a download using a data source.

```APIDOC
## TXVodDownloadMediaInfo startDownload(TXVodDownloadDataSource dataSource)

### Description
Download a file using the provided data source.

### Parameters
- **dataSource** (TXVodDownloadDataSource) - The download source.

### Returns
- **TXVodDownloadMediaInfo** - The download object if the request succeeds; otherwise, null.
```

--------------------------------

### startRemoteView()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__android.html

Starts displaying the remote video image. Note: This API is deprecated since v8.0.

```APIDOC
## startRemoteView(String userId, TXCloudVideoView view)

### Description
Start displaying remote video image. This API is not recommended after v8.0. Please use startRemoteView:streamType:view instead.

### Parameters
- **userId** (String) - The ID of the remote user.
- **view** (TXCloudVideoView) - The view component to render the video.
```

--------------------------------

### startMicDeviceTest:testEcho:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Starts a microphone test. Note: This API is deprecated since v8.0.

```APIDOC
## startMicDeviceTest:(NSInteger)interval testEcho:(void(^)(NSInteger volume))testEcho

### Description
Start mic test. This API is not recommended after v8.0. Please use the `startMicDeviceTest` API in TXDeviceManager instead.

### Parameters
- **interval** (NSInteger) - Required - The interval for the test.
- **testEcho** (void(^)(NSInteger volume)) - Required - Callback for volume level.
```

--------------------------------

### startDownload:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodDownloadManager__ios.html

Initiates a download task using a data source object.

```APIDOC
## - (TXVodDownloadMediaInfo *)startDownload:(TXVodDownloadDataSource *)source

### Description
Starts a download task based on the provided source.

### Parameters
- **source** (TXVodDownloadDataSource *) - The download source.

### Returns
- **TXVodDownloadMediaInfo*** - The download object if the request succeeds; otherwise, nil.

### Warning
Currently, only HLS files can be downloaded.
```

--------------------------------

### Setup Video Rendering View on iOS

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloudDef__ios.html

Initializes a UIView and attaches it to the TRTC cloud instance for local video preview.

```objective-c
UIView *videoView = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 360, 640)];
[self.view addSubview:videoView];
[trtcCloud startLocalPreview:YES view:_localView];
```

--------------------------------

### onAudioPlaying

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePlayerObserver__android.html

Triggered when audio playback starts.

```APIDOC
### void onAudioPlaying(V2TXLivePlayer player, boolean firstPlay, Bundle extraInfo)

**Description:** Audio playback event.

**Parameters:**
- **player** (V2TXLivePlayer) - Player object that calls back this notification.
- **firstPlay** (boolean) - Play for the first time.
- **extraInfo** (Bundle) - Extended information.
```

--------------------------------

### startDownload:url:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodDownloadManager__ios.html

Initiates a download task using a username and URL.

```APIDOC
## - (TXVodDownloadMediaInfo *)startDownload:(NSString *)username url:(NSString *)url

### Description
Downloads a file using the specified username and URL.

### Parameters
- **username** (NSString *) - The username.
- **url** (NSString *) - The download URL.
```

--------------------------------

### getDuration()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Gets the total duration of the video.

```APIDOC
## getDuration()

### Description
This API is used to get the total video duration.

### Returns
- **float** - A value in seconds.
```

--------------------------------

### startLocalAudio(int quality)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__android.html

Enables local audio capturing and publishing with a specified sound quality.

```APIDOC
## startLocalAudio(int quality)

### Description
Enables mic capturing and publishes audio to the current room. Other users will receive the onUserAudioAvailable notification.

### Parameters
- **quality** (int) - Required - Sound quality level: TRTCAudioQualitySpeech (16kHz), TRTCAudioQualityDefault (48kHz), or TRTCAudioQualityMusic (48kHz, dual channel, 128 Kbps).

### Attention
This API triggers a mic permission check and will prompt the user if permission is not granted.
```

--------------------------------

### playableDuration()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__ios.html

Gets the playable duration of the stream.

```APIDOC
## playableDuration()

### Description
Returns the playable duration of the stream in seconds.

### Signature
`- (float) playableDuration`
```

--------------------------------

### startSystemAudioLoopback()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Enables system audio capturing to mix computer sound card output into the current audio stream.

```APIDOC
## virtual void startSystemAudioLoopback(const char * deviceName = nullptr)

### Description
Captures audio data from the sound card of the computer and mixes it into the current audio stream. Useful for sharing instructional video audio or background music.

### Parameters
- **deviceName** (const char*) - Optional. If empty, captures the entire system audio. On Windows, can specify a speaker name or an executable file name to capture specific application audio.
```

--------------------------------

### startDownloadUrl()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodDownloadManager__android.html

Initiates a download using a URL.

```APIDOC
## TXVodDownloadMediaInfo startDownloadUrl(String url)

### Description
Download a file from a URL.

### Parameters
- **url** (String) - The download URL.

### Note
This API has been deprecated. It is recommended to use startDownloadUrl(String, String) instead.
```

--------------------------------

### Create and Manage a Sub-instance for Multi-room Participation

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__android.html

Demonstrates how to switch roles between instances and manage sub-instance lifecycle for concurrent room access.

```java
 TRTCCloud mainCloud = TRTCCloud.sharedInstance(mContext); mainCloud.enterRoom(params1, TRTCCloudDef.TRTC_APP_SCENE_LIVE);
    //...
    //Switch the role from "anchor" to "audience" in your own room
    mainCloud.switchRole(TRTCCloudDef.TRTCRoleAudience);
    mainCloud.muteLocalVideo(true);
    mainCloud.muteLocalAudio(true);
    //...
    //Use subcloud to enter another room and switch the role from "audience" to "anchor"
    TRTCCloud subCloud = mainCloud.createSubCloud();
    subCloud.enterRoom(params2, TRTCCloudDef.TRTC_APP_SCENE_LIVE);
    subCloud.switchRole(TRTCCloudDef.TRTCRoleAnchor);
    subCloud.muteLocalVideo(false);
    subCloud.muteLocalAudio(false);
    //...
    //Exit from new room and release it.
    subCloud.exitRoom();
    mainCloud.destroySubCloud(subCloud);
```

--------------------------------

### publishVideo()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__ios.html

Starts pushing the video substream to TRTC.

```APIDOC
## publishVideo()

### Description
Starts pushing the video substream to TRTC.

### Signature
`- (void) publishVideo`
```

--------------------------------

### startScreenCapture:streamType:encParam:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Starts desktop screen sharing for macOS systems, allowing capture of the entire system or a specific application.

```APIDOC
## startScreenCapture:streamType:encParam:

### Description
Start desktop screen sharing (for desktop systems only). This API can capture the screen content of the entire macOS system or a specified application and share it with other users in the same room.

### Signature
- (void) startScreenCapture:(NSView *)view streamType:(TRTCVideoStreamType)streamType encParam:(TRTCVideoEncParam *)encParam;

### Parameters
- **view** (NSView *) - Parent control of the rendering control, which can be set to a null value.
- **streamType** (TRTCVideoStreamType) - Channel used for screen sharing (TRTCVideoStreamTypeBig or TRTCVideoStreamTypeSub).
- **encParam** (TRTCVideoEncParam *) - Image encoding parameters, can be set to nil for SDK defaults.
```

--------------------------------

### startLocalPreview(TXView view)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Enables the local camera preview on desktop platforms.

```APIDOC
## startLocalPreview (Desktop)

### Description
Enables the local camera preview for desktop. Use setCurrentCameraDevice to select the camera before calling this.

### Parameters
- **view** (TXView) - Required - The UI control to render the video.
```

--------------------------------

### publishAudio()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__ios.html

Starts pushing the audio substream to TRTC.

```APIDOC
## publishAudio()

### Description
Starts pushing the audio substream to TRTC.

### Signature
`- (void) publishAudio`
```

--------------------------------

### onVideoPlaying

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePlayerObserver__android.html

Triggered when the video playback starts or resumes.

```APIDOC
### onVideoPlaying(V2TXLivePlayer player, boolean firstPlay, Bundle extraInfo)

**Description**: Video playback event.

**Parameters**:
- **player** (V2TXLivePlayer) - Player object that calls back this notification.
- **firstPlay** (boolean) - Play for the first time.
- **extraInfo** (Bundle) - Extended information.
```

--------------------------------

### startDownloadUrl(String url, String userName)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodDownloadManager__android.html

Initiates a video download from a specified URL.

```APIDOC
### Method
TXVodDownloadMediaInfo startDownloadUrl(String url, String userName)

### Description
Starts the download process for a file located at the provided URL.

### Parameters
- **url** (String) - The URL of the file to download.
- **userName** (String) - The username associated with the download request.

### Returns
- **TXVodDownloadMediaInfo** - The download information object.
```

--------------------------------

### startPublishing:type:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Starts publishing audio/video streams to Tencent Cloud CSS CDN. This method sends a command to the TRTC server to relay the current user's streams to the specified CDN stream ID.

```APIDOC
## startPublishing:type:

### Description
Starts publishing audio/video streams to Tencent Cloud CSS CDN. This API requests the TRTC server to relay the current user's audio/video streams to the CSS CDN using a specified stream ID.

### Method
Objective-C Method

### Signature
- (void)startPublishing:(NSString *)streamId type:(TRTCVideoStreamType)streamType

### Parameters
- **streamId** (NSString *) - Required - Custom stream ID for the live stream.
- **streamType** (TRTCVideoStreamType) - Required - The video stream type. Only `TRTCVideoStreamTypeBig` and `TRTCVideoStreamTypeSub` are supported.

### Attention
You must enable the "Enable Relayed Push" option in the TRTC console before using this API.
```

--------------------------------

### onLocalRecordBegin

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloudListener__android.html

Callback triggered when local recording starts.

```APIDOC
## onLocalRecordBegin(int errCode, String storagePath)

### Description
Notifies the application that local recording has started following a call to startLocalRecording.

### Parameters
- **errCode** (int) - Error code. 0: success, -1: failed, -2: incorrect file extension.
- **storagePath** (String) - The storage path of the recording file.
```

--------------------------------

### mixStreams

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLiveDef__ios.html

Gets or sets the position of each channel of subimage.

```APIDOC
## mixStreams

### Description
Defines the position of each channel of subimage.

### Signature
- (NSArray<V2TXLiveMixStream *>*) mixStreams
```

--------------------------------

### getCurrentPlaybackTime()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Gets the current playback time in seconds.

```APIDOC
## getCurrentPlaybackTime()

### Description
This API is used to get the current playback time.

### Returns
- **float** - A value in seconds.
```

--------------------------------

### getBufferDuration()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Gets the current buffered duration in seconds.

```APIDOC
## getBufferDuration()

### Description
This API is used to get the buffered duration.

### Returns
- **float** - A value in seconds.
```

--------------------------------

### onLocalRecordBegin:storagePath:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloudDelegate__ios.html

Callback triggered when local recording starts.

```APIDOC
## onLocalRecordBegin:storagePath:

### Description
Notifies the application whether the local recording started successfully after calling startLocalRecording.

### Parameters
- **errCode** (NSInteger) - Error code. 0: success; -1: failed; -2: incorrect file extension.
- **storagePath** (NSString *) - Storage path of the recording file.
```

--------------------------------

### setRequestAudioFocus()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Sets whether to get the audio focus automatically.

```APIDOC
## boolean setRequestAudioFocus(boolean requestFocus)

### Description
This API is used to set whether to get the audio focus automatically, which is yes by default. This feature can take effect only if it is set before playback starts.

### Parameters
- **requestFocus** (boolean) - Whether to request audio focus.

### Returns
- **boolean** - true: Setting succeeded; false: Setting failed.
```

--------------------------------

### startMicrophone()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePusher__cplusplus.html

Enables the local microphone for audio input.

```APIDOC
## int32_t startMicrophone()

### Description
Enables the local microphone.

### Returns
- **V2TXLIVE_OK**: Successful.
```

--------------------------------

### getBitrateIndex()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__android.html

Gets the current bitrate index of the video being played.

```APIDOC
## getBitrateIndex()

### Description
This API is used to get the bitrate index of the video being played back.

### Returns
- **int** - The bitrate index of the video being played back.
```

--------------------------------

### startLocalAudio(TRTCAudioQuality quality)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Enables local audio capturing and publishing to the current room.

```APIDOC
## startLocalAudio

### Description
Enables the microphone for capturing and publishing audio. Other users will receive the onUserAudioAvailable notification.

### Parameters
- **quality** (TRTCAudioQuality) - Required - Sound quality level (TRTCAudioQualitySpeech, TRTCAudioQualityDefault, or TRTCAudioQualityMusic).
```

--------------------------------

### setupVideoWidget:insertIndex:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXVodPlayer__ios.html

Creates and configures the video rendering view.

```APIDOC
## setupVideoWidget:(UIView *)view insertIndex:(unsigned int)idx

### Description
Creates the video rendering view used to display video content.

### Parameters
- **view** (UIView *) - The view container for the video.
- **idx** (unsigned int) - The index for insertion.
```

--------------------------------

### Create and Manage a Subinstance with createSubCloud

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__ios.html

Demonstrates creating a subinstance to join a second room while managing roles and stream publishing across instances.

```objective-c
 TRTCCloud *mainCloud = [TRTCCloud sharedInstance]; [mainCloud enterRoom:params1 appScene:TRTCAppSceneLIVE)];
    //...
    //Switch the role from "anchor" to "audience" in your own room
    [mainCloud switchRole:TRTCRoleAudience];
    [mainCloud muteLocalVideo:YES];
    [mainCloud muteLocalAudio:YES];
    //...
    //Use subcloud to enter another room and switch the role from "audience" to "anchor"
    TRTCCloud *subCloud = [mainCloud createSubCloud];
    [subCloud enterRoom:params2 appScene:TRTCAppSceneLIVE)];
    [subCloud switchRole:TRTCRoleAnchor];
    [subCloud muteLocalVideo:NO];
    [subCloud muteLocalAudio:NO];
    //...
    //Exit from new room and release it.
    [subCloud exitRoom];
    [mainCloud destroySubCloud:subCloud];
```

--------------------------------

### updateNetworkTime()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXLiveBase__android.html

Starts the NTP time service to synchronize network time.

```APIDOC
### static int updateNetworkTime()

Starts the NTP time service.

#### Returns
- **int** - 0 if started successfully; < 0 if the start failed.
```

--------------------------------

### startVirtualCamera

Source: https://liteav.sdk.qcloud.com/doc/api/en/interfaceV2TXLivePusher.html

Enables image streaming as a virtual camera source.

```APIDOC
## startVirtualCamera:(TXImage *)image

### Description
Enables the image streaming. Only one capture source (Camera, VirtualCamera, or ScreenCapture) can be active at a time on the same Pusher instance.

### Parameters
- **image** (TXImage) - Required - The image to stream.

### Returns
- **V2TXLiveCode** - Returns V2TXLIVE_OK on success.
```

--------------------------------

### videoBitrate

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLiveDef__ios.html

Gets or sets the bitrate (Kbps) for the resolution of the transcoded video.

```APIDOC
## videoBitrate

### Description
Bitrate (Kbps) for the resolution of the transcoded video.

### Signature
- (NSUInteger) videoBitrate

### Recommended Value
If set to 0, the backend calculates a bitrate based on videoWidth and videoHeight.
```

--------------------------------

### outputStreamId

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLiveDef__ios.html

Gets or sets the ID of the live stream pushed to CDN.

```APIDOC
## outputStreamId

### Description
ID of the live stream pushed to CDN. If not set, the SDK mixes multiple streams in the room into the video stream of the API caller. If set, the SDK mixes multiple streams into the specified live stream ID.

### Signature
- (NSString*) outputStreamId

### Default Value
nil
```

--------------------------------

### startLivePlay(String url)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePlayer__android.html

Initiates the playback of audio and video streams from the specified URL.

```APIDOC
### startLivePlay(String url)

**Description**
Starts playing the audio and video streams. Note: Starting from version 10.7, a valid Licence must be set via V2TXLivePremier#setLicence or TXLiveBase#setLicence.

**Parameters**
- **url** (String) - URL of the audio and video streams to be played. Supports RTMP, HTTP-FLV, and TRTC protocols.

**Returns**
- **int** - Return code V2TXLiveCode: V2TXLIVE_OK (success), V2TXLIVE_ERROR_INVALID_PARAMETER (invalid URL), V2TXLIVE_ERROR_REFUSED (duplicate streamId), TXLIVE_ERROR_INVALID_LICENSE (invalid licence).
```

--------------------------------

### createV2TXLivePlayer()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePlayer__cplusplus.html

Gets the V2TXLivePlayer object pointer during dynamic DLL loading.

```APIDOC
## createV2TXLivePlayer()

### Description
Gets the V2TXLivePlayer object pointer during dynamic DLL loading. Please call releaseV2TXLivePlayer to destruct the object.

### Returns
- **V2TXLivePlayer*** - The V2TXLivePlayer object pointer.
```

--------------------------------

### startCameraDeviceTest:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXDeviceManager__ios.html

Initiates a camera device test for desktop operating systems.

```APIDOC
## startCameraDeviceTest:

### Description
Starts camera testing for desktop OS. You can use the `setCurrentDevice` API to switch between cameras during testing.

### Signature
`- (NSInteger)startCameraDeviceTest:(NSView *)view;`

### Parameters
- **view** (NSView *) - The view to render the camera preview.
```

--------------------------------

### onVideoPlaying:firstPlay:extraInfo:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePlayerObserver__ios.html

Callback triggered when video playback starts or resumes.

```APIDOC
## - (void)onVideoPlaying:(id<V2TXLivePlayer>)player firstPlay:(BOOL)firstPlay extraInfo:(NSDictionary *)extraInfo

### Description
Video playback event notification.

### Parameters
- **player** (id<V2TXLivePlayer>) - The player object that triggers this notification.
- **firstPlay** (BOOL) - Indicates if this is the first time the video is playing.
- **extraInfo** (NSDictionary *) - Extended information regarding the playback event.
```

--------------------------------

### startScreenCapture()

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePusher__android.html

Enables video screen capture. Note that only one capture source (camera, virtual camera, or screen) can be active at a time on the same Pusher instance.

```APIDOC
## startScreenCapture()

### Description
Enables video screen capture. If switching from another capture source, ensure the previous source is stopped first.

### Returns
- **V2TXLIVE_OK**: Successful operation.
```

--------------------------------

### startVirtualCamera:

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePusher__ios.html

Enables image streaming as a virtual camera source. Note that only one capture source can be active at a time per Pusher instance.

```APIDOC
## startVirtualCamera:(TXImage *)image

### Description
Enables the image streaming. If using the same Pusher instance, only one capture source (Camera, VirtualCamera, or ScreenCapture) can be active at a time.

### Parameters
- **image** (TXImage *) - The image to be streamed.

### Returns
- **V2TXLiveCode** - V2TXLIVE_OK if successful.
```

--------------------------------

### startLocalPreview(bool frontCamera, TXView view)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Enables the local camera preview on mobile platforms.

```APIDOC
## startLocalPreview (Mobile)

### Description
Enables the local camera preview. If called before enterRoom, it waits for room entry to start pushing; if called after, it starts pushing immediately.

### Parameters
- **frontCamera** (bool) - Required - true for front camera, false for rear.
- **view** (TXView) - Required - The UI control to render the video.
```

--------------------------------

### TXPlayInfoParams(int appId, String fileId, String pSign)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXPlayInfoParams__android.html

Constructor for initializing video playback parameters.

```APIDOC
## TXPlayInfoParams(int appId, String fileId, String pSign)

### Description
The constructor for video playback through fileId.

### Parameters
- **appId** (int) - Required - The appId of the video.
- **fileId** (String) - Required - The fileId of the video.
- **pSign** (String) - Required - The video encryption signature, required for encrypted videos.
```

--------------------------------

### startRemoteView

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TRTCCloud__cplusplus.html

Subscribes to a remote user's video stream and binds it to a rendering control.

```APIDOC
## virtual void startRemoteView(const char *userId, TRTCVideoStreamType streamType, TXView view)

### Description
Pulls the video stream of a specified user and renders it to the provided view control. Notification of the first frame is received via onFirstVideoFrame.

### Parameters
- **userId** (const char *) - Required - The ID of the remote user.
- **streamType** (TRTCVideoStreamType) - Required - The video stream type (Big, Small, or Sub).
- **view** (TXView) - Required - The rendering control to display the video.
```

--------------------------------

### videoGOP

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLiveDef__ios.html

Gets or sets the keyframe interval (GOP) for the resolution of the transcoded video.

```APIDOC
## videoGOP

### Description
Keyframe interval (GOP) for the resolution of the transcoded video.

### Signature
- (NSUInteger) videoGOP

### Value Range
[1, 8]; default: 2 (sec)
```

--------------------------------

### initWithLiveMode:()

Source: https://liteav.sdk.qcloud.com/doc/api/en/interfaceV2TXLivePusher.html

Initializes the pusher with a specific live mode.

```APIDOC
## initWithLiveMode:(V2TXLiveMode)liveMode

### Description
Initializes the pusher instance.

### Parameters
- **liveMode** (V2TXLiveMode) - Required - Push protocol type: RTMP/ROOM protocol, default: RTMP
```

--------------------------------

### videoFramerate

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLiveDef__ios.html

Gets or sets the frame rate (fps) for the resolution of the transcoded video.

```APIDOC
## videoFramerate

### Description
Frame rate (fps) for the resolution of the transcoded video.

### Signature
- (NSUInteger) videoFramerate

### Value Range
(0, 30]; default: 15
```

--------------------------------

### getApplicationPlayVolume

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__TXDeviceManager__cplusplus.html

Gets the volume level of the current process in the volume mixer on Windows.

```APIDOC
## virtual int getApplicationPlayVolume()

### Description
Gets the volume level of the current process in the volume mixer on Windows.
```

--------------------------------

### startVirtualCamera(Bitmap image)

Source: https://liteav.sdk.qcloud.com/doc/api/en/group__V2TXLivePusher__android.html

Enables image streaming using a provided Bitmap. Only one capture source can be active at a time.

```APIDOC
## startVirtualCamera(Bitmap image)

### Description
Enables the image streaming. Ensure the previous capture source is stopped before calling this method.

### Parameters
- **image** (Bitmap) - The image to stream.

### Returns
- **V2TXLIVE_OK**: Successful operation.
```
Tokens:
Raw