com.tencentcloudapi.trtc.v20190722.models

Class StartStreamIngestRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.StartStreamIngestRequest

public class StartStreamIngestRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
StartStreamIngestRequest()
StartStreamIngestRequest(StartStreamIngestRequest 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
AudioEncodeParams	getAudioEncodeParams() Deprecated.
Boolean	getAutoPush() Get Enable auto relay to cdn, please make sure that this feature has been enabled in the console.
Long	getMaxDuration() Get Loop playback maximum duration, only effective when RepeatNum is set to -1, valid value range: [1, 10080], unit: minutes
String	getPrivateMapKey() Get TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console.
Long	getRepeatNum() Get Loop playback count, value range: [-1, 1000], default is 1 time.
String	getRoomId() Get TRTC's [RoomId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#roomid), the RoomId corresponding to the Record TRTC room.
Long	getRoomIdType() Get Type of TRTC RoomId.
Long	getSdkAppId() Get TRTC's [SdkAppId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#sdkappid), the same as the SdkAppId corresponding to the Record room.
Long	getSeekSecond() Get
String[]	getSourceUrl() Deprecated.
String	getStreamUrl() Get The Url of the media resource.
String	getUserId() Get UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.
String	getUserSig() Get UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room.
VideoEncodeParams	getVideoEncodeParams() Deprecated.
void	setAudioEncodeParams(AudioEncodeParams AudioEncodeParams) Deprecated.
void	setAutoPush(Boolean AutoPush) Set Enable auto relay to cdn, please make sure that this feature has been enabled in the console.
void	setMaxDuration(Long MaxDuration) Set Loop playback maximum duration, only effective when RepeatNum is set to -1, valid value range: [1, 10080], unit: minutes
void	setPrivateMapKey(String PrivateMapKey) Set TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console.
void	setRepeatNum(Long RepeatNum) Set Loop playback count, value range: [-1, 1000], default is 1 time.
void	setRoomId(String RoomId) Set TRTC's [RoomId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#roomid), the RoomId corresponding to the Record TRTC room.
void	setRoomIdType(Long RoomIdType) Set Type of TRTC RoomId.
void	setSdkAppId(Long SdkAppId) Set TRTC's [SdkAppId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#sdkappid), the same as the SdkAppId corresponding to the Record room.
void	setSeekSecond(Long SeekSecond) Set
void	setSourceUrl(String[] SourceUrl) Deprecated.
void	setStreamUrl(String StreamUrl) Set The Url of the media resource.
void	setUserId(String UserId) Set UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.
void	setUserSig(String UserSig) Set UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room.
void	setVideoEncodeParams(VideoEncodeParams VideoEncodeParams) Deprecated.
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, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

StartStreamIngestRequest

public StartStreamIngestRequest()

StartStreamIngestRequest

public StartStreamIngestRequest(StartStreamIngestRequest 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

getSdkAppId

public Long getSdkAppId()

Get TRTC's [SdkAppId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#sdkappid), the same as the SdkAppId corresponding to the Record room.

Returns:

SdkAppId TRTC's [SdkAppId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#sdkappid), the same as the SdkAppId corresponding to the Record room.

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set TRTC's [SdkAppId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#sdkappid), the same as the SdkAppId corresponding to the Record room.

Parameters:

SdkAppId - TRTC's [SdkAppId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#sdkappid), the same as the SdkAppId corresponding to the Record room.

getRoomId

public String getRoomId()

Get TRTC's [RoomId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#roomid), the RoomId corresponding to the Record TRTC room.

Returns:

RoomId TRTC's [RoomId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#roomid), the RoomId corresponding to the Record TRTC room.

setRoomId

public void setRoomId(String RoomId)

Set TRTC's [RoomId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#roomid), the RoomId corresponding to the Record TRTC room.

Parameters:

RoomId - TRTC's [RoomId](https://intl.cloud.tencent.com/document/product/647/46351?from_cn_redirect=1#roomid), the RoomId corresponding to the Record TRTC room.

getRoomIdType

public Long getRoomIdType()

Get Type of TRTC RoomId. [*Note] Must be the same as the RoomId type corresponding to the Record room: 0: String type RoomId 1: 32-bit Integer type RoomId (default)

Returns:

RoomIdType Type of TRTC RoomId. [*Note] Must be the same as the RoomId type corresponding to the Record room: 0: String type RoomId 1: 32-bit Integer type RoomId (default)

setRoomIdType

public void setRoomIdType(Long RoomIdType)

Set Type of TRTC RoomId. [*Note] Must be the same as the RoomId type corresponding to the Record room: 0: String type RoomId 1: 32-bit Integer type RoomId (default)

Parameters:

RoomIdType - Type of TRTC RoomId. [*Note] Must be the same as the RoomId type corresponding to the Record room: 0: String type RoomId 1: 32-bit Integer type RoomId (default)

getUserId

public String getUserId()

Get UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.

Returns:

UserId UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.

setUserId

public void setUserId(String UserId)

Set UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.

Parameters:

UserId - UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.

getUserSig

public String getUserSig()

Get UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room. For the specific Calculation method, please refer to the TRTC [UserSig](https://www.tencentcloud.com/zh/document/product/647/39074) Scheme.

Returns:

UserSig UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room. For the specific Calculation method, please refer to the TRTC [UserSig](https://www.tencentcloud.com/zh/document/product/647/39074) Scheme.

setUserSig

public void setUserSig(String UserSig)

Set UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room. For the specific Calculation method, please refer to the TRTC [UserSig](https://www.tencentcloud.com/zh/document/product/647/39074) Scheme.

Parameters:

UserSig - UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room. For the specific Calculation method, please refer to the TRTC [UserSig](https://www.tencentcloud.com/zh/document/product/647/39074) Scheme.

getStreamUrl

public String getStreamUrl()

Get The Url of the media resource.

Returns:

StreamUrl The Url of the media resource.

setStreamUrl

public void setStreamUrl(String StreamUrl)

Set The Url of the media resource.

Parameters:

StreamUrl - The Url of the media resource.

getPrivateMapKey

public String getPrivateMapKey()

Get TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console. After enabling advanced permission control in the TRTC Console, TRTC's backend service system will verify a so-called [PrivateMapKey] 'Permission ticket', which contains an encrypted RoomId and an encrypted 'Permission bit list'. Since PrivateMapKey contains RoomId, providing only UserSig without PrivateMapKey does not allow entry into the specified room.

Returns:

PrivateMapKey TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console. After enabling advanced permission control in the TRTC Console, TRTC's backend service system will verify a so-called [PrivateMapKey] 'Permission ticket', which contains an encrypted RoomId and an encrypted 'Permission bit list'. Since PrivateMapKey contains RoomId, providing only UserSig without PrivateMapKey does not allow entry into the specified room.

setPrivateMapKey

public void setPrivateMapKey(String PrivateMapKey)

Set TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console. After enabling advanced permission control in the TRTC Console, TRTC's backend service system will verify a so-called [PrivateMapKey] 'Permission ticket', which contains an encrypted RoomId and an encrypted 'Permission bit list'. Since PrivateMapKey contains RoomId, providing only UserSig without PrivateMapKey does not allow entry into the specified room.

Parameters:

PrivateMapKey - TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console. After enabling advanced permission control in the TRTC Console, TRTC's backend service system will verify a so-called [PrivateMapKey] 'Permission ticket', which contains an encrypted RoomId and an encrypted 'Permission bit list'. Since PrivateMapKey contains RoomId, providing only UserSig without PrivateMapKey does not allow entry into the specified room.

getVideoEncodeParams

@Deprecated
public VideoEncodeParams getVideoEncodeParams()

Deprecated.

Get Video Codec Parameters. Optional, if not filled, Keep original stream Parameters.

Returns:

VideoEncodeParams Video Codec Parameters. Optional, if not filled, Keep original stream Parameters.

setVideoEncodeParams

@Deprecated
public void setVideoEncodeParams(VideoEncodeParams VideoEncodeParams)

Deprecated.

Set Video Codec Parameters. Optional, if not filled, Keep original stream Parameters.

Parameters:

VideoEncodeParams - Video Codec Parameters. Optional, if not filled, Keep original stream Parameters.

getAudioEncodeParams

@Deprecated
public AudioEncodeParams getAudioEncodeParams()

Deprecated.

Get Audio Codec Parameters. Optional, if not filled, Keep original stream Parameters.

Returns:

AudioEncodeParams Audio Codec Parameters. Optional, if not filled, Keep original stream Parameters.

setAudioEncodeParams

@Deprecated
public void setAudioEncodeParams(AudioEncodeParams AudioEncodeParams)

Deprecated.

Set Audio Codec Parameters. Optional, if not filled, Keep original stream Parameters.

Parameters:

AudioEncodeParams - Audio Codec Parameters. Optional, if not filled, Keep original stream Parameters.

getSourceUrl

@Deprecated
public String[] getSourceUrl()

Deprecated.

Get Source URL. Example value: https://a.b/test.mp4

Returns:

SourceUrl Source URL. Example value: https://a.b/test.mp4

setSourceUrl

@Deprecated
public void setSourceUrl(String[] SourceUrl)

Deprecated.

Set Source URL. Example value: https://a.b/test.mp4

Parameters:

SourceUrl - Source URL. Example value: https://a.b/test.mp4

getSeekSecond

public Long getSeekSecond()

Get

Returns:

SeekSecond

setSeekSecond

public void setSeekSecond(Long SeekSecond)

Set

Parameters:

SeekSecond -

getAutoPush

public Boolean getAutoPush()

Get Enable auto relay to cdn, please make sure that this feature has been enabled in the console.

Returns:

AutoPush Enable auto relay to cdn, please make sure that this feature has been enabled in the console.

setAutoPush

public void setAutoPush(Boolean AutoPush)

Set Enable auto relay to cdn, please make sure that this feature has been enabled in the console.

Parameters:

AutoPush - Enable auto relay to cdn, please make sure that this feature has been enabled in the console.

getRepeatNum

public Long getRepeatNum()

Get Loop playback count, value range: [-1, 1000], default is 1 time. - 0 is an invalid value - -1 is for loop playback, task termination requires actively calling the stop interface or setting MaxDuration.

Returns:

RepeatNum Loop playback count, value range: [-1, 1000], default is 1 time. - 0 is an invalid value - -1 is for loop playback, task termination requires actively calling the stop interface or setting MaxDuration.

setRepeatNum

public void setRepeatNum(Long RepeatNum)

Set Loop playback count, value range: [-1, 1000], default is 1 time. - 0 is an invalid value - -1 is for loop playback, task termination requires actively calling the stop interface or setting MaxDuration.

Parameters:

RepeatNum - Loop playback count, value range: [-1, 1000], default is 1 time. - 0 is an invalid value - -1 is for loop playback, task termination requires actively calling the stop interface or setting MaxDuration.

getMaxDuration

public Long getMaxDuration()

Get Loop playback maximum duration, only effective when RepeatNum is set to -1, valid value range: [1, 10080], unit: minutes

Returns:

MaxDuration Loop playback maximum duration, only effective when RepeatNum is set to -1, valid value range: [1, 10080], unit: minutes

setMaxDuration

public void setMaxDuration(Long MaxDuration)

Set Loop playback maximum duration, only effective when RepeatNum is set to -1, valid value range: [1, 10080], unit: minutes

Parameters:

MaxDuration - Loop playback maximum duration, only effective when RepeatNum is set to -1, valid value range: [1, 10080], unit: minutes

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel