com.tencentcloudapi.trtc.v20190722.models

Class EncodeParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.EncodeParams

public class EncodeParams
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
EncodeParams()
EncodeParams(EncodeParams source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getAudioBitrate() Get Output audio bitrate (Kbps) for On-Cloud MixTranscoding.
Long	getAudioChannels() Get Number of sound channels of output stream for On-Cloud MixTranscoding.
Long	getAudioCodec() Get Output audio codec for On-Cloud MixTranscoding.
Long	getAudioSampleRate() Get Output audio sample rate (Hz) for On-Cloud MixTranscoding.
Long	getBackgroundColor() Get Output background color for On-Cloud MixTranscoding.
Long	getBackgroundImageId() Get Output stream background image for stream mix.
String	getBackgroundImageUrl() Get URL of the background image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel.
Long	getVideoBitrate() Get Output bitrate (Kbps) for On-Cloud MixTranscoding, which is required for audio-video output.
Long	getVideoFramerate() Get Output stream frame rate for On-Cloud MixTranscoding in FPS.
Long	getVideoGop() Get Output stream GOP in seconds for On-Cloud MixTranscoding, which is required for audio/video output.
Long	getVideoHeight() Get Output stream height in pixels for On-Cloud MixTranscoding, which is required for audio/video output.
Long	getVideoWidth() Get Output stream width in pixels for On-Cloud MixTranscoding, which is required for audio/video output.
void	setAudioBitrate(Long AudioBitrate) Set Output audio bitrate (Kbps) for On-Cloud MixTranscoding.
void	setAudioChannels(Long AudioChannels) Set Number of sound channels of output stream for On-Cloud MixTranscoding.
void	setAudioCodec(Long AudioCodec) Set Output audio codec for On-Cloud MixTranscoding.
void	setAudioSampleRate(Long AudioSampleRate) Set Output audio sample rate (Hz) for On-Cloud MixTranscoding.
void	setBackgroundColor(Long BackgroundColor) Set Output background color for On-Cloud MixTranscoding.
void	setBackgroundImageId(Long BackgroundImageId) Set Output stream background image for stream mix.
void	setBackgroundImageUrl(String BackgroundImageUrl) Set URL of the background image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel.
void	setVideoBitrate(Long VideoBitrate) Set Output bitrate (Kbps) for On-Cloud MixTranscoding, which is required for audio-video output.
void	setVideoFramerate(Long VideoFramerate) Set Output stream frame rate for On-Cloud MixTranscoding in FPS.
void	setVideoGop(Long VideoGop) Set Output stream GOP in seconds for On-Cloud MixTranscoding, which is required for audio/video output.
void	setVideoHeight(Long VideoHeight) Set Output stream height in pixels for On-Cloud MixTranscoding, which is required for audio/video output.
void	setVideoWidth(Long VideoWidth) Set Output stream width in pixels for On-Cloud MixTranscoding, which is required for audio/video output.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncodeParams

public EncodeParams()

EncodeParams

public EncodeParams(EncodeParams source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getAudioSampleRate

public Long getAudioSampleRate()

Get Output audio sample rate (Hz) for On-Cloud MixTranscoding. Valid values: 48000, 44100, 32000, 24000, 16000, 8000

Returns:

AudioSampleRate Output audio sample rate (Hz) for On-Cloud MixTranscoding. Valid values: 48000, 44100, 32000, 24000, 16000, 8000

setAudioSampleRate

public void setAudioSampleRate(Long AudioSampleRate)

Set Output audio sample rate (Hz) for On-Cloud MixTranscoding. Valid values: 48000, 44100, 32000, 24000, 16000, 8000

Parameters:

AudioSampleRate - Output audio sample rate (Hz) for On-Cloud MixTranscoding. Valid values: 48000, 44100, 32000, 24000, 16000, 8000

getAudioBitrate

public Long getAudioBitrate()

Get Output audio bitrate (Kbps) for On-Cloud MixTranscoding. Value range: 8-500

Returns:

AudioBitrate Output audio bitrate (Kbps) for On-Cloud MixTranscoding. Value range: 8-500

setAudioBitrate

public void setAudioBitrate(Long AudioBitrate)

Set Output audio bitrate (Kbps) for On-Cloud MixTranscoding. Value range: 8-500

Parameters:

AudioBitrate - Output audio bitrate (Kbps) for On-Cloud MixTranscoding. Value range: 8-500

getAudioChannels

public Long getAudioChannels()

Get Number of sound channels of output stream for On-Cloud MixTranscoding. Valid values: 1, 2. 1 represents mono-channel, and 2 represents dual-channel.

Returns:

AudioChannels Number of sound channels of output stream for On-Cloud MixTranscoding. Valid values: 1, 2. 1 represents mono-channel, and 2 represents dual-channel.

setAudioChannels

public void setAudioChannels(Long AudioChannels)

Set Number of sound channels of output stream for On-Cloud MixTranscoding. Valid values: 1, 2. 1 represents mono-channel, and 2 represents dual-channel.

Parameters:

AudioChannels - Number of sound channels of output stream for On-Cloud MixTranscoding. Valid values: 1, 2. 1 represents mono-channel, and 2 represents dual-channel.

getVideoWidth

public Long getVideoWidth()

Get Output stream width in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1920].

Returns:

VideoWidth Output stream width in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1920].

setVideoWidth

public void setVideoWidth(Long VideoWidth)

Set Output stream width in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1920].

Parameters:

VideoWidth - Output stream width in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1920].

getVideoHeight

public Long getVideoHeight()

Get Output stream height in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1080].

Returns:

VideoHeight Output stream height in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1080].

setVideoHeight

public void setVideoHeight(Long VideoHeight)

Set Output stream height in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1080].

Parameters:

VideoHeight - Output stream height in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1080].

getVideoBitrate

public Long getVideoBitrate()

Get Output bitrate (Kbps) for On-Cloud MixTranscoding, which is required for audio-video output. Value range: 1-10000

Returns:

VideoBitrate Output bitrate (Kbps) for On-Cloud MixTranscoding, which is required for audio-video output. Value range: 1-10000

setVideoBitrate

public void setVideoBitrate(Long VideoBitrate)

Set Output bitrate (Kbps) for On-Cloud MixTranscoding, which is required for audio-video output. Value range: 1-10000

Parameters:

VideoBitrate - Output bitrate (Kbps) for On-Cloud MixTranscoding, which is required for audio-video output. Value range: 1-10000

getVideoFramerate

public Long getVideoFramerate()

Get Output stream frame rate for On-Cloud MixTranscoding in FPS. This parameter is required for audio/video outputs. Value range: [1, 60].

Returns:

VideoFramerate Output stream frame rate for On-Cloud MixTranscoding in FPS. This parameter is required for audio/video outputs. Value range: [1, 60].

setVideoFramerate

public void setVideoFramerate(Long VideoFramerate)

Set Output stream frame rate for On-Cloud MixTranscoding in FPS. This parameter is required for audio/video outputs. Value range: [1, 60].

Parameters:

VideoFramerate - Output stream frame rate for On-Cloud MixTranscoding in FPS. This parameter is required for audio/video outputs. Value range: [1, 60].

getVideoGop

public Long getVideoGop()

Get Output stream GOP in seconds for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [1, 5].

Returns:

VideoGop Output stream GOP in seconds for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [1, 5].

setVideoGop

public void setVideoGop(Long VideoGop)

Set Output stream GOP in seconds for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [1, 5].

Parameters:

VideoGop - Output stream GOP in seconds for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [1, 5].

getBackgroundColor

public Long getBackgroundColor()

Get Output background color for On-Cloud MixTranscoding. Valid values: decimal integers. Commonly used colors include: Red: 0xff0000, whose decimal number is 16724736 Yellow: 0xffff00, whose decimal number is 16776960 Green: 0x33cc00, whose decimal number is 3394560 Blue: 0x0066ff, whose decimal number is 26367 Black: 0x000000, whose decimal number is 0 White: 0xFFFFFF, whose decimal number is 16777215 Grey: 0x999999, whose decimal number is 10066329

Returns:

BackgroundColor Output background color for On-Cloud MixTranscoding. Valid values: decimal integers. Commonly used colors include: Red: 0xff0000, whose decimal number is 16724736 Yellow: 0xffff00, whose decimal number is 16776960 Green: 0x33cc00, whose decimal number is 3394560 Blue: 0x0066ff, whose decimal number is 26367 Black: 0x000000, whose decimal number is 0 White: 0xFFFFFF, whose decimal number is 16777215 Grey: 0x999999, whose decimal number is 10066329

setBackgroundColor

public void setBackgroundColor(Long BackgroundColor)

Set Output background color for On-Cloud MixTranscoding. Valid values: decimal integers. Commonly used colors include: Red: 0xff0000, whose decimal number is 16724736 Yellow: 0xffff00, whose decimal number is 16776960 Green: 0x33cc00, whose decimal number is 3394560 Blue: 0x0066ff, whose decimal number is 26367 Black: 0x000000, whose decimal number is 0 White: 0xFFFFFF, whose decimal number is 16777215 Grey: 0x999999, whose decimal number is 10066329

Parameters:

BackgroundColor - Output background color for On-Cloud MixTranscoding. Valid values: decimal integers. Commonly used colors include: Red: 0xff0000, whose decimal number is 16724736 Yellow: 0xffff00, whose decimal number is 16776960 Green: 0x33cc00, whose decimal number is 3394560 Blue: 0x0066ff, whose decimal number is 26367 Black: 0x000000, whose decimal number is 0 White: 0xFFFFFF, whose decimal number is 16777215 Grey: 0x999999, whose decimal number is 10066329

getBackgroundImageId

public Long getBackgroundImageId()

Get Output stream background image for stream mix. Its value is the ID of image uploaded through the TRTC Console.

Returns:

BackgroundImageId Output stream background image for stream mix. Its value is the ID of image uploaded through the TRTC Console.

setBackgroundImageId

public void setBackgroundImageId(Long BackgroundImageId)

Set Output stream background image for stream mix. Its value is the ID of image uploaded through the TRTC Console.

Parameters:

BackgroundImageId - Output stream background image for stream mix. Its value is the ID of image uploaded through the TRTC Console.

getAudioCodec

public Long getAudioCodec()

Get Output audio codec for On-Cloud MixTranscoding. Valid values: 0, 1, 2. 0 (default): LC-AAC; 1: HE-AAC; 2: HE-AACv2. If this parameter is set to 2 (HE-AACv2), On-Cloud MixTranscoding can produce only dual-channel streams. If it is set to 1 (HE-AAC) or 2 (HE-AACv2), the valid values for the audio sample rate of output streams are 48000, 44100, 32000, 24000, and 16000.

Returns:

AudioCodec Output audio codec for On-Cloud MixTranscoding. Valid values: 0, 1, 2. 0 (default): LC-AAC; 1: HE-AAC; 2: HE-AACv2. If this parameter is set to 2 (HE-AACv2), On-Cloud MixTranscoding can produce only dual-channel streams. If it is set to 1 (HE-AAC) or 2 (HE-AACv2), the valid values for the audio sample rate of output streams are 48000, 44100, 32000, 24000, and 16000.

setAudioCodec

public void setAudioCodec(Long AudioCodec)

Set Output audio codec for On-Cloud MixTranscoding. Valid values: 0, 1, 2. 0 (default): LC-AAC; 1: HE-AAC; 2: HE-AACv2. If this parameter is set to 2 (HE-AACv2), On-Cloud MixTranscoding can produce only dual-channel streams. If it is set to 1 (HE-AAC) or 2 (HE-AACv2), the valid values for the audio sample rate of output streams are 48000, 44100, 32000, 24000, and 16000.

Parameters:

AudioCodec - Output audio codec for On-Cloud MixTranscoding. Valid values: 0, 1, 2. 0 (default): LC-AAC; 1: HE-AAC; 2: HE-AACv2. If this parameter is set to 2 (HE-AACv2), On-Cloud MixTranscoding can produce only dual-channel streams. If it is set to 1 (HE-AAC) or 2 (HE-AACv2), the valid values for the audio sample rate of output streams are 48000, 44100, 32000, 24000, and 16000.

getBackgroundImageUrl

public String getBackgroundImageUrl()

Get URL of the background image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel. The URL must not exceed 512 bytes. When both `BackgroundImageUrl` and `BackgroundImageId` are specified, the former will be used. The background image must not exceed 10 MB.

Returns:

BackgroundImageUrl URL of the background image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel. The URL must not exceed 512 bytes. When both `BackgroundImageUrl` and `BackgroundImageId` are specified, the former will be used. The background image must not exceed 10 MB.

setBackgroundImageUrl

public void setBackgroundImageUrl(String BackgroundImageUrl)

Set URL of the background image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel. The URL must not exceed 512 bytes. When both `BackgroundImageUrl` and `BackgroundImageId` are specified, the former will be used. The background image must not exceed 10 MB.

Parameters:

BackgroundImageUrl - URL of the background image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel. The URL must not exceed 512 bytes. When both `BackgroundImageUrl` and `BackgroundImageId` are specified, the former will be used. The background image must not exceed 10 MB.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel