V2TXLivePusher

Last updated: 2021-08-13 20:26:53

Overview

Tencent Cloud’s live stream publisher

Features

V2TXLivePusher encodes local audio and video and publishes the encoded data to a specified URL. It supports any publishing server.
V2TXLivePusher has the following capabilities:

  • Custom video capturing. You can customize audio and video data sources based on your project requirements.
  • Retouching, filters, and stickers. V2TXLivePusher integrates multiple retouching algorithms (natural & smooth) and color space filters (custom filters are supported).
  • QoS control technology. V2TXLivePusher can adapt automatically to different upstream network conditions by controlling audio/video traffic in real time based on the network conditions of hosts.
  • Facial feature adjustment and animated widgets. Powered by YouTu’s AI face recognition technology, V2TXLivePusher supports animated widgets and fine-tuning of facial features, such as eye enlarging, face slimming, and nose reshaping. You need to purchase a YouTu license to use these live streaming effects.

Basic SDK APIs

setObserver

This API is used to set the callbacks of the publisher. After the setting, you can listen for callbacks of V2TXLivePusher, including publisher status, volume, statistics, warning and error messages, etc.

public abstract void setObserver(V2TXLivePusherObserver observer);

Parameters

Parameter Type Description
observer V2TXLivePusherObserver Target object for the publisher’s callbacks. For more information, please see V2TXLivePusherObserver.

Basic Publishing APIs

setRenderView

This API is used to set the view for local camera preview. Images collected by the local camera are displayed on the view passed in after retouching, facial feature adjustments, and filter application.

public abstract int setRenderView(TXCloudVideoView view);

Parameters

Parameter Type Description
view TXCloudVideoView View for local camera preview

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


setRenderView

This API is used to set the view for local camera preview. Images collected by the local camera are displayed on the view passed in after retouching, facial feature adjustments, and filter application.

public abstract int setRenderView(SurfaceView view);

Parameters

Parameter Type Description
view SurfaceView View for local camera preview

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


setRenderView

This API is used to set the view for local camera preview. Images collected by the local camera are displayed on the view passed in after retouching, facial feature adjustments, and filter application.

public abstract int setRenderView(TextureView view);

Parameters

Parameter Type Description
view TextureView View for local camera preview

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


startPush

This API is used to start publishing audio/video data.

public abstract int startPush(String url);

Parameters

Parameter Type Description
url String URL to which data is published. Any publishing server is supported.

Response

V2TXLiveCode:

  • V2TXLIVE_OK: successful
  • V2TXLIVE_ERROR_INVALID_PARAMETER: failed because the URL is invalid.
  • V2TXLIVE_ERROR_REFUSED: RTC does not support using the same stream ID for publishing and playback on the same device.

stopPush

This API is used to stop publishing audio/video data.

public abstract int stopPush();

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


isPushing

This API is used to get whether the publisher is publishing streams.

public abstract int isPushing();

Response

Whether streams are being published

  • 1: yes
  • 0: no

startScreenCapture

This API is used to start screen recording.

public abstract int startScreenCapture();

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


stopScreenCapture

This API is used to stop screen recording.

public abstract int stopScreenCapture();

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


Video APIs

setVideoQuality

This API is used to set the resolution and aspect ratio mode (portrait/landscape) of published video.

public abstract int setVideoQuality(V2TXLiveVideoResolution resolution, V2TXLiveVideoResolutionMode resolutionMode);

Parameters

Parameter Type Description
resolution V2TXLiveVideoResolution Video resolution
resolutionMode V2TXLiveVideoResolutionMode Orientation (portrait/landscape)

V2TXLiveVideoResolution enumerated values

Value Description
V2TXLiveVideoResolution160x160 Resolution: 160 x 160; bitrate: 100-150 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution270x270 Resolution: 270 x 270; bitrate: 200-300 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution480x480 Resolution: 480 x 480; bitrate: 350-525 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution320x240 Resolution: 320 x 240; bitrate: 250-375 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution480x360 Resolution: 480 x 360; bitrate: 400-600 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution640x480 Resolution: 640 x 480; bitrate: 600-900 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution320x180 Resolution: 320 x 180: bitrate: 250-400 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution480x270 Resolution: 480 x 270; bitrate: 350-550 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution640x360 Resolution: 640 x 360; bitrate: 500-900 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution960x540 Resolution: 960 x 540; bitrate: 800-1500 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution1280x720 Resolution: 1280 x 720; bitrate: 1000-1800 Kbps; frame rate: 15 FPS
V2TXLiveVideoResolution1920x1080 Resolution: 1920 x 1080; bitrate: 2500-3000 Kbps; frame rate: 15 FPS

V2TXLiveVideoResolutionMode enumerated values

Value Description
V2TXLiveVideoResolutionModeLandscape Resolution in the landscape mode: V2TXLiveVideoResolution640_360 + V2TXLiveVideoResolutionModeLandscape = 640 x 360
V2TXLiveVideoResolutionModePortrait Resolution in the portrait mode: V2TXLiveVideoResolution640_360 + V2TXLiveVideoResolutionModePortrait = 360 x 640

setRenderRotation

This API is used to set the rotation of local camera preview.

public abstract int setRenderRotation(V2TXLiveRotation rotation);

Parameters

Parameter Type Description
rotation V2TXLiveRotation Degrees by which the image is rotated. Default value: V2TXLiveRotation0

Response

V2TXLiveCode:
V2TXLIVE_OK: successful

V2TXLiveRotation enumerated values

Value Description
V2TXLiveRotation0 No rotation
V2TXLiveRotation90 Rotate 90 degrees clockwise
V2TXLiveRotation180 Rotate 180 degrees clockwise
V2TXLiveRotation270 Rotate 270 degrees clockwise

setRenderMirror

This API is used to set the mirror mode of local camera preview.

public abstract int setRenderMirror(V2TXLiveMirrorType mirrorType);

Parameters

Parameter Type Description
mirrorType V2TXLiveMirrorType Mirror mode of the camera. Default value: V2TXLiveMirrorTypeAuto

Response

V2TXLiveCode:
V2TXLIVE_OK: successful

V2TXLiveMirrorType enumerated values

Value Description
V2TXLiveMirrorTypeAuto The default value. In this mode, the front camera is mirrored, but the rear camera is not.
V2TXLiveMirrorTypeEnable Both the front and rear cameras are mirrored.
V2TXLiveMirrorTypeDisable Neither the front nor rear camera is mirrored.

startCamera

This API is used to turn the local camera on.

public abstract int startCamera(boolean frontCamera);

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


stopCamera

This API is used to turn the local camera off.

public abstract int stopCamera();

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


snapshot

This API is used to take a screenshot of the local video while it is being published.

Note:

After V2TXLIVE_OK is returned, you can get the screenshot taken in the V2TXLivePusherObserver.onSnapshotComplete callback.

public abstract int snapshot();

Response

V2TXLiveCode:

  • V2TXLIVE_OK: successful
  • V2TXLIVE_ERROR_REFUSED: failed to take a screenshot because publishing has stopped

setWatermark

This API is used to set a watermark for the publisher. Watermarks are disabled by default.

public abstract int setWatermark(Bitmap image, float x, float y, float scale);

Parameters

Parameter Type Description
image Bitmap Watermark image. If this parameter is null, it means watermarks are disabled.
x float Horizontal coordinate of the watermark
y float Vertical coordinate of the watermark
scale float The ratio by which the watermark image is resized

setEncoderMirror

This API is used to set the mirror mode of encoded images.

public abstract int setEncoderMirror(boolean mirror);

Parameters

Parameter Type Description
mirror Boolean Whether to mirror encoded images. Default value: false

enableCustomVideoCapture

This API is used to enable/disable custom video capturing. In the custom video capturing mode, the SDK stops capturing images from the camera, but continues to encode and send images.

public abstract int enableCustomVideoCapture(boolean enable);

Parameters

Parameter Type Description
enable Boolean Whether to enable custom video capturing. Default value: false.

sendCustomVideoFrame

This API is used to send the custom video data captured to the SDK.

public abstract int sendCustomVideoFrame(V2TXLiveVideoFrame videoFrame);

Parameters

Parameter Type Description
videoFrame V2TXLiveVideoFrame Video frames sent to the SDK

Response

V2TXLiveCode:

  • V2TXLIVE_OK: successful
  • TXLIVE_ERROR_INVALID_PARAMETER: failed because the video data is invalid.
  • V2TXLIVE_ERROR_REFUSED: failed. You must call enableCustomVideoCapture to enable custom video capturing first.

enableCustomVideoProcess

This API is used to enable/disable custom video processing.

public abstract int enableCustomVideoProcess(boolean enable, V2TXLivePixelFormat pixelFormat, V2TXLiveBufferType bufferType);

Parameters

Parameter Type Description
enable Boolean Whether to enable custom video processing. Default value: false
pixelFormat V2TXLivePixelFormat Pixel format of video frames
bufferType V2TXLiveBufferType Video data buffer type

V2TXLivePixelFormat enumerated values

Value Description
V2TXLivePixelFormatUnknown Unknown
V2TXLivePixelFormatI420 YUV420P (I420)
V2TXLivePixelFormatTexture2D OpenGL 2D texture

V2TXLiveBufferType enumerated values

Value Description
V2TXLiveBufferTypeUnknown Unknown
V2TXLiveBufferTypeByteBuffer DirectBuffer, which carries buffers in the format of I420 and others and is used at the native layer.
V2TXLiveBufferTypeByteArray byte[], which carries buffers in the format of I420 and others and is used at the Java layer.
V2TXLiveBufferTypeTexture Texture ID, which allows direct operation. It delivers the best performance and has the smallest impact on video quality.

Beauty Filter APIs

getBeautyManager

This API is used to get the beauty filter management object TXBeautyManager.
You can do the following using TXBeautyManager:

Set the beauty filter style and apply effects including skin brightening, rosy skin, eye enlarging, face slimming, chin slimming, chin lengthening/shortening, face shortening, nose narrowing, eye brightening, teeth whitening, eye bag removal, wrinkle removal, and smile line removal

public TXBeautyManager getBeautyManager()

Audio APIs

startMicrophone

This API is used to turn the mic on.

public abstract int startMicrophone();

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


stopMicrophone

This API is used to turn the mic off.

public abstract int stopMicrophone();

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


setAudioQuality

This API is used to set audio quality.

public abstract int setAudioQuality(V2TXLiveAudioQuality quality);

Parameters

Parameter Type Description
quality V2TXLiveAudioQuality Audio quality

V2TXLiveAudioQuality enumerated values

Value Description
V2TXLiveAudioQualitySpeech Speech. Audio sample rate: 16 kHz; sound channel: mono; bitrate: 16 Kbps
This is designed for speech-based call scenarios such as online conferencing and audio call.
V2TXLiveAudioQualityDefault Default. Audio sample rate: 48 kHz; sound channel: mono; bitrate: 50 Kbps
This is the default audio quality of the SDK and is recommended.
V2TXLiveAudioQualityMusic Music. Audio sample rate: 48 kHz; sound channel: dual; bitrate: 128 Kbps
This is designed for music-oriented scenarios with hi-fi requirements, such as karaoke and live music streaming.

Response

V2TXLiveCode:

  • V2TXLIVE_OK: successful
  • V2TXLIVE_ERROR_REFUSED: you cannot change audio quality settings when streams are being published.

enableVolumeEvaluation

This API is used to enable the volume reminder for audio capturing.

Note:

After enabling the volume reminder, you can get the SDK’s volume evaluation through the V2TXLivePusherObserver#onMicrophoneVolumeUpdate(int) callback.

public abstract int enableVolumeEvaluation(int intervalMs);

Parameters

Parameter Type Description
intervalMs int Interval (ms) for triggering the onMicrophoneVolumeUpdate callback. The minimum interval allowed is 100 ms. If the value is 0 (default) or smaller, the callback is disabled. 300 is recommended.

Response

V2TXLiveCode:
V2TXLIVE_OK: successful


Audio Effect APIs

getAudioEffectManager

This API is used to get the audio effect management object TXAudioEffectManager.
You can do the following using TXAudioEffectManager:

  • Set the volume of audio captured by the mic
  • Set reverb and voice changing effects
  • Enable in-ear monitoring and set its volume
  • Add background music and specify how to play it
public TXAudioEffectManager getAudioEffectManager()

Device Management APIs

getDeviceManager

This API is used to get the device management object TXDeviceManager.
You can do the following using TXDeviceManager:

  • Switch between the front and rear cameras
  • Enable autofocus
  • Set camera zoom level
  • Enable/Disable flashlight
public abstract TXDeviceManager getDeviceManager();

Other APIs

setProperty

This API is used to call the advanced APIs of V2TXLivePusher.

public abstract int setProperty(String key, Object value);

Parameters

Parameter Type Description
key String Key of the advanced API to call
value Object Parameters required by the advanced API

Response

V2TXLiveCode:

  • V2TXLIVE_OK: successful
  • V2TXLIVE_ERROR_INVALID_PARAMETER: failed because key is empty.

setMixTranscodingConfig

This API is used to set On-Cloud MixTranscoding parameters. If you have enabled relayed push on the Function Configuration page of the TRTC console, then each channel of image will have a default CDN live streaming address. There may be multiple hosts in a room, each sending their own video and audio, but CDN audience needs only one live stream. Therefore, you need to mix multiple audio/video streams into one standard live stream, which requires MixTranscoding.

public abstract int setMixTranscodingConfig(V2TXLiveTranscodingConfig config);

Parameters

Parameter Type Description
config V2TXLiveTranscodingConfig On-Cloud MixTranscoding configuration

|---------|---------|


showDebugView

This API is used to display the dashboard.

public abstract void showDebugView(boolean isShow);

Parameters

Parameter Type Description
isShow boolean Whether to display the dashboard. Default value: false