LiteAVSDK
Tencent Cloud LVB SDK, is a high availability components serving tens of thousands of enterprise customers, which is committed to helping you to minimize your research and development costs.
V2TXLivePusher

Detailed Description

Tencent Cloud live pusher.
The live pusher encodes the local audio and video data and pushes the encoded data to a specified push URL.

The pusher has the following capabilities:


Data Structure Documentation

◆ V2TXLivePusher

class V2TXLivePusher

Instance Methods

(void) - setObserver
 
(V2TXLiveCode- setRenderView
 
(V2TXLiveCode- setRenderMirror
 
(V2TXLiveCode- setEncoderMirror
 
(V2TXLiveCode- setRenderRotation
 
(V2TXLiveCode- startCamera
 
(V2TXLiveCode- startCamera
 
(V2TXLiveCode- stopCamera
 
(V2TXLiveCode- startMicrophone
 
(V2TXLiveCode- stopMicrophone
 
(V2TXLiveCode- startScreenCapture
 
(V2TXLiveCode- stopScreenCapture
 
(V2TXLiveCode- startPush
 
(V2TXLiveCode- stopPush
 
(int) - isPushing
 
(V2TXLiveCode- setAudioQuality
 
(V2TXLiveCode- setVideoQuality:resolutionMode
 
(TXBeautyManager *) - getBeautyManager
 
(TXAudioEffectManager *) - getAudioEffectManager
 
(TXDeviceManager *) - getDeviceManager
 
(V2TXLiveCode- snapshot
 
(V2TXLiveCode- setWatermark:x:y:scale
 
(V2TXLiveCode- enableVolumeEvaluation
 
(V2TXLiveCode- enableCustomVideoCapture
 
(V2TXLiveCode- sendCustomVideoFrame
 
(V2TXLiveCode- setProperty:value
 
(void) - showDebugView
 

Method Documentation

◆ setObserver()

- (void) setObserver: (id< V2TXLivePusherObserver >)  observer

Sets the pusher callback.
By setting the callback, you can listen to some callback events of V2TXLivePusher, including the pusher status, volume callback, statistics, warnings, and error messages.

Parameters
observerCallback target of the pusher. For more information, see V2TXLivePusherObserver.

◆ setRenderView()

- (V2TXLiveCode) setRenderView: (TXView *)  view

Sets the local camera preview.
Images collected by the local camera will be eventually displayed on the view that is passed in after it is overlaid by multiple effects, such as beauty filters, facial feature adjustments, and filters.

Parameters
viewLocal camera preview.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ setRenderMirror()

- (V2TXLiveCode) setRenderMirror: (V2TXLiveMirrorType mirrorType

Sets the view mirror of the local camera.
Local cameras are divided into the front camera and the rear camera. By default, images from the front camera are mirrored, and images from the rear camera are not mirrored. Here, you can modify the default mirror type of the front or rear camera.

Parameters
mirrorTypeMirror type of the camera V2TXLiveMirrorType .
  • V2TXLiveMirrorTypeAuto [Default]: default mirror type. In this case, images from the front camera are mirrored, and images from the rear camera are not mirrored.
  • V2TXLiveMirrorTypeEnable: both the front camera and rear camera are switched to mirror mode.
  • V2TXLiveMirrorTypeDisable: both the front camera and rear camera are switched to non-mirror mode.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ setEncoderMirror()

- (V2TXLiveCode) setEncoderMirror: (BOOL)  mirror

Sets the video encoder mirror.

Attention
The encoder mirror only influences video effects on the audience side.
Parameters
mirrorSpecifies whether the mirrored images are viewed.
  • NO [Default]: non-mirrored images are viewed on the player side.
  • YES: mirrored images are viewed on the player side.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ setRenderRotation()

- (V2TXLiveCode) setRenderRotation: (V2TXLiveRotation rotation

Sets the rotation angle of the view.

Attention
Only the view is rotated, and images that are pushed are not affected.
Parameters
rotationRotation angle of the view V2TXLiveRotation .
  • V2TXLiveRotation0 [Default]: 0 degrees, which means the view is not rotated.
  • V2TXLiveRotation90: rotate 90 degrees clockwise.
  • V2TXLiveRotation180: rotate 180 degrees clockwise.
  • V2TXLiveRotation270: rotate 270 degrees clockwise.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ startCamera() [1/2]

- (V2TXLiveCode) startCamera: (BOOL)  frontCamera

Enables the local camera.

Parameters
frontCameraSpecifies whether to switch to the front camera.
  • YES [Default]: switch to the front camera.
  • NO: switch to the rear camera.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ startCamera() [2/2]

- (V2TXLiveCode) startCamera: (NSString *)  cameraId

Enables the local camera.

Parameters
cameraIdcamera id
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ stopCamera()

- (V2TXLiveCode) stopCamera

Disables the local camera.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ startMicrophone()

- (V2TXLiveCode) startMicrophone

Enables the local microphone.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ stopMicrophone()

- (V2TXLiveCode) stopMicrophone

Disables the microphone.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ startScreenCapture()

- (V2TXLiveCode) startScreenCapture: (NSString *)  appGroup

Enables video capturing.

Attention
The iOS system currently does not support the use of this API to enable video capture.
iOS Broadcast Upload Extension must be used to enable video capture. Then, enableCustomVideoCapture is called to enable custom video capture. Finally, sendCustomVideoFrame is called to send video data collected in Broadcast Upload Extension.
Parameters
appGroupThe Application Group Identifier shared by the main App and Broadcast can be specified as nil. It is worth noting that the function will be more reliable according to the document guidelines.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_ERROR_NOT_SUPPORTED: this feature is not supported.

◆ stopScreenCapture()

- (V2TXLiveCode) stopScreenCapture

Disables video capture.

Attention
The iOS system currently does not support the use of this API to disable video capture.
You can directly disable video capture on the video recording screen of the iOS system. Alternatively, you can call enableCustomVideoCapture to disable video capture.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_ERROR_NOT_SUPPORTED: this feature is not supported.

◆ startPush()

- (V2TXLiveCode) startPush: (NSString *)  url

Starts pushing the audio and video data.

Parameters
urlPush URL, which can be any push server.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: operation succeeded. The pusher starts connecting to the target push URL.
  • 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, please ensure that no other player or pusher is using this streamId now.

◆ stopPush()

- (V2TXLiveCode) stopPush

Stops pushing the audio and video data.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ isPushing()

- (int) isPushing

Indicates whether the pusher is currently pushing streams.

Returns
Indicates whether the pusher is pushing streams.
  • 1: yes
  • 0: no

◆ setAudioQuality()

- (V2TXLiveCode) setAudioQuality: (V2TXLiveAudioQuality quality

Sets the audio quality for pushing.

Parameters
qualityAudio quality V2TXLiveAudioQuality .
  • V2TXLiveAudioQualityDefault [Default]: universal
  • V2TXLiveAudioQualitySpeech: speech
  • V2TXLiveAudioQualityMusic: music
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful
  • V2TXLIVE_ERROR_REFUSED: the audio quality cannot be adjusted in the pushing process.

◆ setVideoQuality:resolutionMode()

- (V2TXLiveCode) setVideoQuality: (V2TXLiveVideoResolution resolution
resolutionMode: (V2TXLiveVideoResolutionMode resolutionMode 

Sets the video resolution and aspect ratio mode (portrait or landscape) for pushing.

Parameters
resolutionVideo resolution. [Default]: V2TXLiveVideoResolution960x540 V2TXLiveVideoResolution
resolutionModeAspect ratio mode (portrait or landscape). [Default]: V2TXLiveVideoResolutionModePortrait V2TXLiveVideoResolutionMode
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ getBeautyManager()

- (TXBeautyManager *) getBeautyManager

Obtains the beauty manager TXBeautyManager.

With the beauty manager, you can use the following features:

  • Set the following cosmetic effects: beauty style, whitening, ruddy, big eyes, slim face, V-shape face, chin, short face, small nose, bright eyes, white teeth, remove eye bags, remove wrinkles, remove laugh lines.
  • Adjust the hairline, eye spacing, eye corners, mouth shape, nose wings, nose position, lip thickness, and face shape.
  • Set animated effects such as face widgets (materials).
  • Add makeup effects.
  • Recognize gestures.

◆ getAudioEffectManager()

- (TXAudioEffectManager *) getAudioEffectManager

Obtains the audio effect manager TXAudioEffectManager .

With the audio effect manager, you can use the following features:

  • Adjust the volume of human voice collected by the microphone.
  • Set the reverb and voice changing effects.
  • Start the headphone monitor, and set the volume of the headphone monitor.
  • Add the BGM, and adjust the playback effect of BGM.

◆ getDeviceManager()

- (TXDeviceManager *) getDeviceManager

Obtains the video device manager TXDeviceManager .

With the device manager, you can use the following features:

  • Switch between the front and rear cameras.
  • Set the auto focus.
  • Adjust the camera magnification.
  • Turn the flash on or off.
  • Switch between the earphone and speaker.
  • Modify the volume type (media volume or conversation volume).

◆ snapshot()

- (V2TXLiveCode) snapshot

Captures the local view in the pushing process.

Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful
  • V2TXLIVE_ERROR_REFUSED: pushing is stopped, and the snapshot operation cannot be called.

◆ setWatermark:x:y:scale()

- (V2TXLiveCode) setWatermark: (TXImage *)  image
x: (float)  x
y: (float)  y
scale: (float)  scale 

Sets the pusher watermark image. By default, the watermark is disabled.

Parameters
imageWatermark image. If the value is nil, it is equivalent to disabling the watermark.
xDisplay position of the watermark. Valid range: 0 - 1.
yDisplay position of the watermark. Valid range: 0 - 1.
scaleScaling ratio of the watermark. Valid range: 0 - 1.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ enableVolumeEvaluation()

- (V2TXLiveCode) enableVolumeEvaluation: (NSInteger)  intervalMs

Enables volume update.
After this feature is enabled, you can obtain the volume evaluation through the onMicrophoneVolumeUpdate callback.

Parameters
intervalMsInterval for triggering the volume callback. The unit is ms. The minimum interval is 100 ms. If the value is equal to or smaller than 0, the callback is disabled. We recommend that you set this parameter to 300 ms. [Default]: 0.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ enableCustomVideoCapture()

- (V2TXLiveCode) enableCustomVideoCapture: (BOOL)  enable

Enables or disables custom video capture.
In the custom video capture mode, the SDK no longer captures images from cameras. Only the encoding and sending capabilities are retained.

Attention
This API takes effect only when it is called before startPush .
Parameters
enableYES: enable custom video capture; NO: disable custom video capture. [Default]: NO
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful

◆ sendCustomVideoFrame()

- (V2TXLiveCode) sendCustomVideoFrame: (V2TXLiveVideoFrame *)  videoFrame

Sends the collected video data to the SDK in the custom video capture mode.
In the custom video capture mode, the SDK no longer captures images from cameras. Only the encoding and sending capabilities are retained. You can pack collected SampleBuffer packets into V2TXLiveVideoFrame and periodically send them through this API.

Attention
You must call enableCustomVideoCapture to enable custom video capture before startPush .
Parameters
videoFrameVideo frames sent to the SDK V2TXLiveVideoFrame .
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful
  • V2TXLIVE_ERROR_INVALID_PARAMETER: The video frames fail to be sent because they are invalid.
  • V2TXLIVE_ERROR_REFUSED: You must call enableCustomVideoCapture to enable custom video capture before startPush .

◆ setProperty:value()

- (V2TXLiveCode) setProperty: (NSString *)  key
value: (NSObject *)  value 

Calls the advanced API of V2TXLivePusher.

Attention
This API is used to call some advanced features.
Parameters
keyKey of the advanced API.
valueParameter needed to call the advanced API corresponding to the key.
Returns
Return code V2TXLiveCode
  • V2TXLIVE_OK: successful
  • V2TXLIVE_ERROR_INVALID_PARAMETER: operation failed. The key cannot be nil.

◆ showDebugView()

- (void) showDebugView: (BOOL)  isShow

Indicates whether the debug view of the pusher video status information is displayed.

Parameters
isShowSpecifies whether to display the debug view. [Default]: NO