Agora RTC Objective-C API Reference
Refactor
|
Data Fields | |
int | width |
int | height |
int | videoBitrate |
int | videoFramerate |
bool | lowLatency |
int | videoGop |
VIDEO_CODEC_PROFILE_TYPE | videoCodecProfile |
unsigned int | backgroundColor |
VIDEO_CODEC_TYPE_FOR_STREAM | videoCodecType |
unsigned int | userCount |
TranscodingUser * | transcodingUsers |
const char * | transcodingExtraInfo |
const char * | metadata |
RtcImage * | watermark |
unsigned int | watermarkCount |
RtcImage * | backgroundImage |
unsigned int | backgroundImageCount |
AUDIO_SAMPLE_RATE_TYPE | audioSampleRate |
int | audioBitrate |
int | audioChannels |
AUDIO_CODEC_PROFILE_TYPE | audioCodecProfile |
The definition of the LiveTranscoding struct.
|
inline |
int width |
The width of the video in pixels. The default value is 360.
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.width
and height
as 0. int height |
The height of the video in pixels. The default value is 640.
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.width
and height
as 0. int videoBitrate |
Bitrate of the CDN live output video stream. The default value is 400 Kbps.
Set this parameter according to the Video Bitrate Table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.
int videoFramerate |
Frame rate of the output video stream set for the CDN live streaming. The default value is 15 fps, and the value range is (0,30].
bool lowLatency |
DEPRECATED Latency mode:
int videoGop |
Video GOP in frames. The default value is 30 fps.
VIDEO_CODEC_PROFILE_TYPE videoCodecProfile |
Self-defined video codec profile: VIDEO_CODEC_PROFILE_TYPE.
unsigned int 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).
VIDEO_CODEC_TYPE_FOR_STREAM videoCodecType |
video codec type
unsigned int userCount |
The number of users in the live interactive streaming. The value range is [0, 17].
TranscodingUser* transcodingUsers |
const char* 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 frame, see SEI-related questions.
const char* metadata |
DEPRECATED The metadata sent to the CDN live client defined by the RTMP or HTTP-FLV metadata.
RtcImage* 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 the watermark image. See RtcImage.
unsigned int 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 The value range is [0, 100].
RtcImage* 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 the background image. See RtcImage.
unsigned int 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 The value range is [0, 100].
AUDIO_SAMPLE_RATE_TYPE audioSampleRate |
Self-defined audio-sample rate: AUDIO_SAMPLE_RATE_TYPE.
int audioBitrate |
Bitrate of the CDN live audio output stream. The default value is 48 Kbps, and the highest value is 128.
int audioChannels |
The numbder 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 option 3, 4, or 5:
AUDIO_CODEC_PROFILE_TYPE audioCodecProfile |
Self-defined audio codec profile: AUDIO_CODEC_PROFILE_TYPE.