LiveTranscoding

Transcoding configurations for Media Push.

export class LiveTranscoding {

  width?: number;

  height?: number;

  videoBitrate?: number;

  videoFramerate?: number;

  lowLatency?: boolean;

  videoGop?: number;

  videoCodecProfile?: VideoCodecProfileType;

  backgroundColor?: number;

  videoCodecType?: VideoCodecTypeForStream;

  userCount?: number;

  transcodingUsers?: TranscodingUser[];

  transcodingExtraInfo?: string;

  metadata?: string;

  watermark?: RtcImage[];

  watermarkCount?: number;

  backgroundImage?: RtcImage[];

  backgroundImageCount?: number;

  audioSampleRate?: AudioSampleRateType;

  audioBitrate?: number;

  audioChannels?: number;

  audioCodecProfile?: AudioCodecProfileType;

  advancedFeatures?: LiveStreamAdvancedFeature[];

  advancedFeatureCount?: number;
}

Attributes

width

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

  • When pushing video streams to the CDN, the value range of width is [64,1920]. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1920, Agora server automatically adjusts it to 1920.
  • When pushing audio streams to the CDN, set width and height as 0.
height

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

  • When pushing video streams to the CDN, the value range of height is [64,1080]. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1080, Agora server automatically adjusts it to 1080.
  • When pushing audio streams to the CDN, set width and height as 0.
videoBitrate

The encoding bitrate (Kbps) of the video. This parameter does not need to be set; keeping the default value STANDARD_BITRATE is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution and frame rate, see Video profile.

videoFrameRate

Frame rate (fps) of the output video stream set for Media Push. The default value is 15. The value range is (0,30].

Attention: The Agora server adjusts any value over 30 to 30.
lowLatency
Deprecated
This member is deprecated.

Latency mode:

  • true: Low latency with unassured quality.
  • false: (Default) High latency with assured quality.
videoGop
GOP (Group of Pictures) in fps of the video frames for Media Push. The default value is 30.
videoCodecProfile

Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See VideoCodecProfileType for details.

Attention: If you set this parameter to any other value, Agora adjusts it to the default value.
videoCodecType
Video codec profile types for Media Push. See VideoCodecTypeForStream.
transcodingUsers

Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See TranscodingUser.

transcodingExtraInfo

Reserved property. Extra user-defined information to send SEI for the H.264/H.265 video stream to the CDN live client. Maximum length: 4096 bytes. For more information on SEI, see SEI-related questions.

backgroundColor

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

userCount

The number of users in the Media Push. The value range is [0,17].

metadata
Deprecated
Obsolete and not recommended for use.

The metadata sent to the CDN client.

watermark

The watermark on the live video. The image format needs to be PNG. See RtcImage.

You can add one watermark, or add multiple watermarks using an array. This parameter is used with watermarkCount.

backgroundImage

The number of background images on the live video. The image format needs to be PNG. See RtcImage.

You can add a background image or use an array to add multiple background images. This parameter is used with backgroundImageCount.

audioSampleRate

The audio sampling rate (Hz) of the output media stream. See AudioSampleRateType.

audioBitrate

Bitrate (Kbps) of the audio output stream for Media Push. The default value is 48, and the highest value is 128.

audioChannels

The number of audio channels for Media Push. 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
Audio codec profile type for Media Push. See AudioCodecProfileType.
watermarkCount
The number of watermarks on the live video. The total number of watermarks and background images can range from 0 to 10. This parameter is used with watermark.
backgroundImageCount
The number of background images on the live video. The total number of watermarks and background images can range from 0 to 10. This parameter is used with backgroundImage.
advancedFeatures
Advanced features of the Media Push with transcoding. See LiveStreamAdvancedFeature.
advancedFeatureCount
The number of enabled advanced features. The default value is 0.