Agora Java API Reference for Android
Public Member Functions | Public Attributes | List of all members
io.agora.rte.media.stream.AgoraRteLiveTranscoding Class Reference

Public Member Functions

int getHeight ()
 
int getWidth ()
 
AgoraImage getBackgroundImage ()
 
AgoraImage getWatermark ()
 
AgoraRteAudioCodecProfileType getAudioCodecProfile ()
 
AgoraRteAudioSampleRateType getAudioSampleRate ()
 
AgoraRteTranscodingUser getTranscodingUsers ()
 
AgoraRteVideoCodecProfileType getVideoCodecProfile ()
 
boolean isLowLatency ()
 
byte[] getMetadata ()
 
int getAudioBitrate ()
 
int getAudioChannels ()
 
int getVideoBitrate ()
 
int getVideoFramerate ()
 
int getVideoGop ()
 
long getBackgroundColor ()
 
long getBackgroundImageCount ()
 
long getUserCount ()
 
long getWatermarkCount ()
 
byte[] getTranscodingExtraInfo ()
 

Public Attributes

int width
 
int height
 
int videoBitrate
 
int videoFramerate
 
boolean lowLatency
 
int videoGop
 
AgoraRteVideoCodecProfileType videoCodecProfile
 
long backgroundColor
 
long userCount
 
AgoraRteTranscodingUser transcodingUsers
 
byte[] transcodingExtraInfo
 
byte[] metadata
 
AgoraImage watermark
 
long watermarkCount
 
AgoraImage backgroundImage
 
long backgroundImageCount
 
AgoraRteAudioSampleRateType audioSampleRate
 
int audioBitrate
 
int audioChannels
 
AgoraRteAudioCodecProfileType audioCodecProfile
 

Member Data Documentation

◆ width

int io.agora.rte.media.stream.AgoraRteLiveTranscoding.width

The width of the video in pixels. The default value is 360.

  • When pushing video streams to the CDN, ensure that width is at least 64; otherwise, the Agora server adjusts the value to 64.
  • When pushing audio streams to the CDN, set width and height as 0..

◆ height

int io.agora.rte.media.stream.AgoraRteLiveTranscoding.height

The height of the video in pixels. The default value is 640.

  • When pushing video streams to the CDN, ensure that height is at least 64; otherwise, the Agora server adjusts the value to 64.
  • When pushing audio streams to the CDN, set width and height as 0.

◆ videoBitrate

int io.agora.rte.media.stream.AgoraRteLiveTranscoding.videoBitrate

The bitrate (Kbps) of the video. The default value is 400. Set this parameter according to the bitrate you set in VideoEncoderConfiguration. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.

◆ videoFramerate

int io.agora.rte.media.stream.AgoraRteLiveTranscoding.videoFramerate

The frame rate (fps) of the video that ranges from 0 to 30. The default value is 15. The server adjusts any value over 30 to 30.

◆ lowLatency

boolean io.agora.rte.media.stream.AgoraRteLiveTranscoding.lowLatency

Determines whether to enable low latency.

  • true: Low latency with unassured quality.
  • false: (Default) High latency with assured quality.

◆ videoGop

int io.agora.rte.media.stream.AgoraRteLiveTranscoding.videoGop

Gop (Group of video) of the video frames in the CDN live stream. The default value is 30 fps.

◆ videoCodecProfile

AgoraRteVideoCodecProfileType io.agora.rte.media.stream.AgoraRteLiveTranscoding.videoCodecProfile

The video codec profile: #AgoraRteVideoCodecProfileType.

◆ backgroundColor

long io.agora.rte.media.stream.AgoraRteLiveTranscoding.backgroundColor

The background color in RGB hex. Value only, do not include a preceeding #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black).

◆ userCount

long io.agora.rte.media.stream.AgoraRteLiveTranscoding.userCount

The number of users in the live broadcast.

◆ transcodingUsers

AgoraRteTranscodingUser io.agora.rte.media.stream.AgoraRteLiveTranscoding.transcodingUsers

The user layout configuration in the CDN live streaming.: TranscodingUser.

◆ transcodingExtraInfo

byte [] io.agora.rte.media.stream.AgoraRteLiveTranscoding.transcodingExtraInfo

Extra user-defined information sent to the CDN client. The extra infomation will be transmitted by SEI packets.

◆ metadata

byte [] io.agora.rte.media.stream.AgoraRteLiveTranscoding.metadata

The pointer to the metadata sent to the CDN client.

◆ watermark

AgoraImage io.agora.rte.media.stream.AgoraRteLiveTranscoding.watermark

The watermark image added to the CDN live publishing stream. Ensure that the format of the image is PNG. Once a watermark image is added, the audience of the CDN live publishing stream can see it. See #AgoraRteRtcImage.

◆ watermarkCount

long io.agora.rte.media.stream.AgoraRteLiveTranscoding.watermarkCount

The variables means the count of watermark. if watermark is array, watermarkCount is count of watermark. if watermark is just a pointer, watermarkCount pointer to object address. At the same time, watermarkCount must be 0 or 1. default value: 0, compatible with old user-api

◆ backgroundImage

AgoraImage io.agora.rte.media.stream.AgoraRteLiveTranscoding.backgroundImage

The background image added to the CDN live publishing stream. Once a background image is added, the audience of the CDN live publishing stream can see it. See #AgoraRteRtcImage.

◆ backgroundImageCount

long io.agora.rte.media.stream.AgoraRteLiveTranscoding.backgroundImageCount

The variables means the count of backgroundImage. if backgroundImage is array, backgroundImageCount is count of backgroundImage. if backgroundImage is just a pointer, backgroundImageCount pointer to object address. At the same time, backgroundImageCount must be 0 or 1. default value: 0, compatible with old user-api

◆ audioSampleRate

AgoraRteAudioSampleRateType io.agora.rte.media.stream.AgoraRteLiveTranscoding.audioSampleRate

The audio sample rates: #AgoraRteAudioSampleRateType.

◆ audioBitrate

int io.agora.rte.media.stream.AgoraRteLiveTranscoding.audioBitrate

The bitrate (Kbps) of the audio output stream set for CDN live. The default value is 48 and the highest value is 128.

◆ audioChannels

int io.agora.rte.media.stream.AgoraRteLiveTranscoding.audioChannels

The number of audio channels for the CDN live stream. Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose 3, 4, or 5.

  • 1: (Default) Mono.
  • 2: Stereo.
  • 3: Three audio channels.
  • 4: Four audio channels.
  • 5: Five audio channels.

◆ audioCodecProfile

AgoraRteAudioCodecProfileType io.agora.rte.media.stream.AgoraRteLiveTranscoding.audioCodecProfile

The audio codec profile type: #AgoraRteAudioCodecProfileType.