com.tencentcloudapi.live.v20180801.models

Class CreateLivePullStreamTaskRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.live.v20180801.models.CreateLivePullStreamTaskRequest

public class CreateLivePullStreamTaskRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateLivePullStreamTaskRequest()
CreateLivePullStreamTaskRequest(CreateLivePullStreamTaskRequest 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
String	getAppName() Get The application to push to.
String	getBackupSourceType() Get The backup source type.
String	getBackupSourceUrl() Get The URL of the backup source.
String[]	getCallbackEvents() Get The events to listen for.
String	getCallbackUrl() Get A custom callback URL.
String	getComment() Get The remarks for a task, not longer than 512 bytes.
String	getDomainName() Get The push domain name.
String	getEndTime() Get The end time.
String	getExtraCmd() Get Other parameters.
String	getOperator() Get The operator.
String	getPushArgs() Get The push parameter.
String	getSourceType() Get The source type.
String[]	getSourceUrls() Get The source URL(s).
String	getStartTime() Get The start time.
String	getStreamName() Get The stream name.
String	getToUrl() Get The complete destination URL.
Long	getVodLocalMode() Get Whether to use local mode when the source type is video files.
String	getVodLoopTimes() Get The number of times to loop video files.
String	getVodRefreshType() Get The behavior after the source video files (`SourceUrls`) are changed.
PullPushWatermarkInfo[]	getWatermarkList() Get The information of watermarks to add.
void	setAppName(String AppName) Set The application to push to.
void	setBackupSourceType(String BackupSourceType) Set The backup source type.
void	setBackupSourceUrl(String BackupSourceUrl) Set The URL of the backup source.
void	setCallbackEvents(String[] CallbackEvents) Set The events to listen for.
void	setCallbackUrl(String CallbackUrl) Set A custom callback URL.
void	setComment(String Comment) Set The remarks for a task, not longer than 512 bytes.
void	setDomainName(String DomainName) Set The push domain name.
void	setEndTime(String EndTime) Set The end time.
void	setExtraCmd(String ExtraCmd) Set Other parameters.
void	setOperator(String Operator) Set The operator.
void	setPushArgs(String PushArgs) Set The push parameter.
void	setSourceType(String SourceType) Set The source type.
void	setSourceUrls(String[] SourceUrls) Set The source URL(s).
void	setStartTime(String StartTime) Set The start time.
void	setStreamName(String StreamName) Set The stream name.
void	setToUrl(String ToUrl) Set The complete destination URL.
void	setVodLocalMode(Long VodLocalMode) Set Whether to use local mode when the source type is video files.
void	setVodLoopTimes(String VodLoopTimes) Set The number of times to loop video files.
void	setVodRefreshType(String VodRefreshType) Set The behavior after the source video files (`SourceUrls`) are changed.
void	setWatermarkList(PullPushWatermarkInfo[] WatermarkList) Set The information of watermarks to add.
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

CreateLivePullStreamTaskRequest

public CreateLivePullStreamTaskRequest()

CreateLivePullStreamTaskRequest

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

getSourceType

public String getSourceType()

Get The source type. Valid values: PullLivePushLive: Live streaming PullVodPushLive: Video files PullPicPushLive: Images

Returns:

SourceType The source type. Valid values: PullLivePushLive: Live streaming PullVodPushLive: Video files PullPicPushLive: Images

setSourceType

public void setSourceType(String SourceType)

Set The source type. Valid values: PullLivePushLive: Live streaming PullVodPushLive: Video files PullPicPushLive: Images

Parameters:

SourceType - The source type. Valid values: PullLivePushLive: Live streaming PullVodPushLive: Video files PullPicPushLive: Images

getSourceUrls

public String[] getSourceUrls()

Get The source URL(s). If `SourceType` is `PullLivePushLive`, you can specify only one source URL. If `SourceType` is `PullVodPushLive`, you can specify at most 30 source URLs. Supported file formats: FLV, MP4, HLS. Supported protocols: HTTP, HTTPS, RTMP, RTMPS, RTSP, SRT. Notes: 1. We recommend you use FLV files as the source. Poorly interleaved MP4 files may result in playback stuttering. You can also re-interleave your MP4 files before adding them as the source. 2. Do not use private network domains or malicious URLs. CSS will block accounts that do. 3. To avoid push and playback issues, make sure the source files are properly interleaved. 4. Supported video coding formats: H.264, H.265. 5. Supported audio coding format: AAC. 6. Use small video files, preferably not longer than one hour. Large files may take a long time to load or resume after pause. Relay may fail if the time consumed exceeds 15 seconds.

Returns:

SourceUrls The source URL(s). If `SourceType` is `PullLivePushLive`, you can specify only one source URL. If `SourceType` is `PullVodPushLive`, you can specify at most 30 source URLs. Supported file formats: FLV, MP4, HLS. Supported protocols: HTTP, HTTPS, RTMP, RTMPS, RTSP, SRT. Notes: 1. We recommend you use FLV files as the source. Poorly interleaved MP4 files may result in playback stuttering. You can also re-interleave your MP4 files before adding them as the source. 2. Do not use private network domains or malicious URLs. CSS will block accounts that do. 3. To avoid push and playback issues, make sure the source files are properly interleaved. 4. Supported video coding formats: H.264, H.265. 5. Supported audio coding format: AAC. 6. Use small video files, preferably not longer than one hour. Large files may take a long time to load or resume after pause. Relay may fail if the time consumed exceeds 15 seconds.

setSourceUrls

public void setSourceUrls(String[] SourceUrls)

Set The source URL(s). If `SourceType` is `PullLivePushLive`, you can specify only one source URL. If `SourceType` is `PullVodPushLive`, you can specify at most 30 source URLs. Supported file formats: FLV, MP4, HLS. Supported protocols: HTTP, HTTPS, RTMP, RTMPS, RTSP, SRT. Notes: 1. We recommend you use FLV files as the source. Poorly interleaved MP4 files may result in playback stuttering. You can also re-interleave your MP4 files before adding them as the source. 2. Do not use private network domains or malicious URLs. CSS will block accounts that do. 3. To avoid push and playback issues, make sure the source files are properly interleaved. 4. Supported video coding formats: H.264, H.265. 5. Supported audio coding format: AAC. 6. Use small video files, preferably not longer than one hour. Large files may take a long time to load or resume after pause. Relay may fail if the time consumed exceeds 15 seconds.

Parameters:

SourceUrls - The source URL(s). If `SourceType` is `PullLivePushLive`, you can specify only one source URL. If `SourceType` is `PullVodPushLive`, you can specify at most 30 source URLs. Supported file formats: FLV, MP4, HLS. Supported protocols: HTTP, HTTPS, RTMP, RTMPS, RTSP, SRT. Notes: 1. We recommend you use FLV files as the source. Poorly interleaved MP4 files may result in playback stuttering. You can also re-interleave your MP4 files before adding them as the source. 2. Do not use private network domains or malicious URLs. CSS will block accounts that do. 3. To avoid push and playback issues, make sure the source files are properly interleaved. 4. Supported video coding formats: H.264, H.265. 5. Supported audio coding format: AAC. 6. Use small video files, preferably not longer than one hour. Large files may take a long time to load or resume after pause. Relay may fail if the time consumed exceeds 15 seconds.

getDomainName

public String getDomainName()

Get The push domain name. The pulled stream is pushed to this domain. Note: If the destination is not a CSS address and its format is different from that of CSS addresses, pass the full address to `ToUrl`. For details, see the description of the `ToUrl` parameter.

Returns:

DomainName The push domain name. The pulled stream is pushed to this domain. Note: If the destination is not a CSS address and its format is different from that of CSS addresses, pass the full address to `ToUrl`. For details, see the description of the `ToUrl` parameter.

setDomainName

public void setDomainName(String DomainName)

Set The push domain name. The pulled stream is pushed to this domain. Note: If the destination is not a CSS address and its format is different from that of CSS addresses, pass the full address to `ToUrl`. For details, see the description of the `ToUrl` parameter.

Parameters:

DomainName - The push domain name. The pulled stream is pushed to this domain. Note: If the destination is not a CSS address and its format is different from that of CSS addresses, pass the full address to `ToUrl`. For details, see the description of the `ToUrl` parameter.

getAppName

public String getAppName()

Get The application to push to. The pulled stream is pushed to this application.

Returns:

AppName The application to push to. The pulled stream is pushed to this application.

setAppName

public void setAppName(String AppName)

Set The application to push to. The pulled stream is pushed to this application.

Parameters:

AppName - The application to push to. The pulled stream is pushed to this application.

getStreamName

public String getStreamName()

Get The stream name. The pulled stream is pushed under this name.

Returns:

StreamName The stream name. The pulled stream is pushed under this name.

setStreamName

public void setStreamName(String StreamName)

Set The stream name. The pulled stream is pushed under this name.

Parameters:

StreamName - The stream name. The pulled stream is pushed under this name.

getStartTime

public String getStartTime()

Get The start time. It must be in UTC format. Example: 2019-01-08T10:00:00Z. Note: Beijing time is 8 hours ahead of UTC. The [ISO 8601 format](https://intl.cloud.tencent.com/document/product/266/11732#iso-date-format) is used.

Returns:

StartTime The start time. It must be in UTC format. Example: 2019-01-08T10:00:00Z. Note: Beijing time is 8 hours ahead of UTC. The [ISO 8601 format](https://intl.cloud.tencent.com/document/product/266/11732#iso-date-format) is used.

setStartTime

public void setStartTime(String StartTime)

Set The start time. It must be in UTC format. Example: 2019-01-08T10:00:00Z. Note: Beijing time is 8 hours ahead of UTC. The [ISO 8601 format](https://intl.cloud.tencent.com/document/product/266/11732#iso-date-format) is used.

Parameters:

StartTime - The start time. It must be in UTC format. Example: 2019-01-08T10:00:00Z. Note: Beijing time is 8 hours ahead of UTC. The [ISO 8601 format](https://intl.cloud.tencent.com/document/product/266/11732#iso-date-format) is used.

getEndTime

public String getEndTime()

Get The end time. Notes: 1. The end time must be later than the start time. 2. The end time and start time must be later than the current time. 3. The end time and start time must be less than seven days apart. It must be in UTC format. Example: 2019-01-08T10:00:00Z. Note: Beijing time is 8 hours ahead of UTC. The [ISO 8601 format](https://intl.cloud.tencent.com/document/product/266/11732#iso-date-format) is used.

Returns:

EndTime The end time. Notes: 1. The end time must be later than the start time. 2. The end time and start time must be later than the current time. 3. The end time and start time must be less than seven days apart. It must be in UTC format. Example: 2019-01-08T10:00:00Z. Note: Beijing time is 8 hours ahead of UTC. The [ISO 8601 format](https://intl.cloud.tencent.com/document/product/266/11732#iso-date-format) is used.

setEndTime

public void setEndTime(String EndTime)

Set The end time. Notes: 1. The end time must be later than the start time. 2. The end time and start time must be later than the current time. 3. The end time and start time must be less than seven days apart. It must be in UTC format. Example: 2019-01-08T10:00:00Z. Note: Beijing time is 8 hours ahead of UTC. The [ISO 8601 format](https://intl.cloud.tencent.com/document/product/266/11732#iso-date-format) is used.

Parameters:

EndTime - The end time. Notes: 1. The end time must be later than the start time. 2. The end time and start time must be later than the current time. 3. The end time and start time must be less than seven days apart. It must be in UTC format. Example: 2019-01-08T10:00:00Z. Note: Beijing time is 8 hours ahead of UTC. The [ISO 8601 format](https://intl.cloud.tencent.com/document/product/266/11732#iso-date-format) is used.

getOperator

public String getOperator()

Get The operator.

Returns:

Operator The operator.

setOperator

public void setOperator(String Operator)

Set The operator.

Parameters:

Operator - The operator.

getPushArgs

public String getPushArgs()

Get The push parameter. This is a custom parameter carried during push. Example: bak=1&test=2

Returns:

PushArgs The push parameter. This is a custom parameter carried during push. Example: bak=1&test=2

setPushArgs

public void setPushArgs(String PushArgs)

Set The push parameter. This is a custom parameter carried during push. Example: bak=1&test=2

Parameters:

PushArgs - The push parameter. This is a custom parameter carried during push. Example: bak=1&test=2

getCallbackEvents

public String[] getCallbackEvents()

Get The events to listen for. If you do not pass this parameter, all events will be listened for. TaskStart: Callback for starting a task TaskExit: Callback for ending a task VodSourceFileStart: Callback for starting to pull from video files VodSourceFileFinish: Callback for stopping pulling from video files ResetTaskConfig: Callback for modifying a task `TaskAlarm` indicates a warning event. `AlarmType` examples: PullFileUnstable: Pull from video files is unstable. PushStreamUnstable: Push is unstable. PullFileFailed: Error pulling from video files. PushStreamFailed: Push error. FileEndEarly: The video file ended prematurely.

Returns:

CallbackEvents The events to listen for. If you do not pass this parameter, all events will be listened for. TaskStart: Callback for starting a task TaskExit: Callback for ending a task VodSourceFileStart: Callback for starting to pull from video files VodSourceFileFinish: Callback for stopping pulling from video files ResetTaskConfig: Callback for modifying a task `TaskAlarm` indicates a warning event. `AlarmType` examples: PullFileUnstable: Pull from video files is unstable. PushStreamUnstable: Push is unstable. PullFileFailed: Error pulling from video files. PushStreamFailed: Push error. FileEndEarly: The video file ended prematurely.

setCallbackEvents

public void setCallbackEvents(String[] CallbackEvents)

Set The events to listen for. If you do not pass this parameter, all events will be listened for. TaskStart: Callback for starting a task TaskExit: Callback for ending a task VodSourceFileStart: Callback for starting to pull from video files VodSourceFileFinish: Callback for stopping pulling from video files ResetTaskConfig: Callback for modifying a task `TaskAlarm` indicates a warning event. `AlarmType` examples: PullFileUnstable: Pull from video files is unstable. PushStreamUnstable: Push is unstable. PullFileFailed: Error pulling from video files. PushStreamFailed: Push error. FileEndEarly: The video file ended prematurely.

Parameters:

CallbackEvents - The events to listen for. If you do not pass this parameter, all events will be listened for. TaskStart: Callback for starting a task TaskExit: Callback for ending a task VodSourceFileStart: Callback for starting to pull from video files VodSourceFileFinish: Callback for stopping pulling from video files ResetTaskConfig: Callback for modifying a task `TaskAlarm` indicates a warning event. `AlarmType` examples: PullFileUnstable: Pull from video files is unstable. PushStreamUnstable: Push is unstable. PullFileFailed: Error pulling from video files. PushStreamFailed: Push error. FileEndEarly: The video file ended prematurely.

getVodLoopTimes

public String getVodLoopTimes()

Get The number of times to loop video files. Default value: -1. -1: Loop indefinitely 0: Do not loop > 0: The number of loop times. A task will end either when the videos are looped for the specified number of times or at the specified task end time, whichever is earlier. This parameter is valid only when the source is video files.

Returns:

VodLoopTimes The number of times to loop video files. Default value: -1. -1: Loop indefinitely 0: Do not loop > 0: The number of loop times. A task will end either when the videos are looped for the specified number of times or at the specified task end time, whichever is earlier. This parameter is valid only when the source is video files.

setVodLoopTimes

public void setVodLoopTimes(String VodLoopTimes)

Set The number of times to loop video files. Default value: -1. -1: Loop indefinitely 0: Do not loop > 0: The number of loop times. A task will end either when the videos are looped for the specified number of times or at the specified task end time, whichever is earlier. This parameter is valid only when the source is video files.

Parameters:

VodLoopTimes - The number of times to loop video files. Default value: -1. -1: Loop indefinitely 0: Do not loop > 0: The number of loop times. A task will end either when the videos are looped for the specified number of times or at the specified task end time, whichever is earlier. This parameter is valid only when the source is video files.

getVodRefreshType

public String getVodRefreshType()

Get The behavior after the source video files (`SourceUrls`) are changed. ImmediateNewSource: Play the new videos immediately ContinueBreakPoint: Play the new videos after the current video is finished playing (the remaining videos in the old playlist will not be played). This parameter is valid only if the source before the change is video files.

Returns:

VodRefreshType The behavior after the source video files (`SourceUrls`) are changed. ImmediateNewSource: Play the new videos immediately ContinueBreakPoint: Play the new videos after the current video is finished playing (the remaining videos in the old playlist will not be played). This parameter is valid only if the source before the change is video files.

setVodRefreshType

public void setVodRefreshType(String VodRefreshType)

Set The behavior after the source video files (`SourceUrls`) are changed. ImmediateNewSource: Play the new videos immediately ContinueBreakPoint: Play the new videos after the current video is finished playing (the remaining videos in the old playlist will not be played). This parameter is valid only if the source before the change is video files.

Parameters:

VodRefreshType - The behavior after the source video files (`SourceUrls`) are changed. ImmediateNewSource: Play the new videos immediately ContinueBreakPoint: Play the new videos after the current video is finished playing (the remaining videos in the old playlist will not be played). This parameter is valid only if the source before the change is video files.

getCallbackUrl

public String getCallbackUrl()

Get A custom callback URL. Callbacks about pull and relay events will be sent to this URL.

Returns:

CallbackUrl A custom callback URL. Callbacks about pull and relay events will be sent to this URL.

setCallbackUrl

public void setCallbackUrl(String CallbackUrl)

Set A custom callback URL. Callbacks about pull and relay events will be sent to this URL.

Parameters:

CallbackUrl - A custom callback URL. Callbacks about pull and relay events will be sent to this URL.

getExtraCmd

public String getExtraCmd()

Get Other parameters. For example, you can use `ignore_region` to ignore the region passed in and assign a region based on load distribution.

Returns:

ExtraCmd Other parameters. For example, you can use `ignore_region` to ignore the region passed in and assign a region based on load distribution.

setExtraCmd

public void setExtraCmd(String ExtraCmd)

Set Other parameters. For example, you can use `ignore_region` to ignore the region passed in and assign a region based on load distribution.

Parameters:

ExtraCmd - Other parameters. For example, you can use `ignore_region` to ignore the region passed in and assign a region based on load distribution.

getComment

public String getComment()

Get The remarks for a task, not longer than 512 bytes.

Returns:

Comment The remarks for a task, not longer than 512 bytes.

setComment

public void setComment(String Comment)

Set The remarks for a task, not longer than 512 bytes.

Parameters:

Comment - The remarks for a task, not longer than 512 bytes.

getToUrl

public String getToUrl()

Get The complete destination URL. If you specify this parameter, make sure you pass in an empty string for `DomainName`, `AppName`, and `StreamName`. Note: Make sure that the expiration time of the signature is later than the task end time.

Returns:

ToUrl The complete destination URL. If you specify this parameter, make sure you pass in an empty string for `DomainName`, `AppName`, and `StreamName`. Note: Make sure that the expiration time of the signature is later than the task end time.

setToUrl

public void setToUrl(String ToUrl)

Set The complete destination URL. If you specify this parameter, make sure you pass in an empty string for `DomainName`, `AppName`, and `StreamName`. Note: Make sure that the expiration time of the signature is later than the task end time.

Parameters:

ToUrl - The complete destination URL. If you specify this parameter, make sure you pass in an empty string for `DomainName`, `AppName`, and `StreamName`. Note: Make sure that the expiration time of the signature is later than the task end time.

getBackupSourceType

public String getBackupSourceType()

Get The backup source type. PullLivePushLive: Live streaming PullVodPushLive: Video files Notes: 1. Backup sources are supported only if the primary source type is live streaming. 2. When pull from the primary source is interrupted, the system will pull from the backup source. 3. If the backup source is a video file, each time the video is finished, the system will check if the primary source is recovered and will switch back if it is.

Returns:

BackupSourceType The backup source type. PullLivePushLive: Live streaming PullVodPushLive: Video files Notes: 1. Backup sources are supported only if the primary source type is live streaming. 2. When pull from the primary source is interrupted, the system will pull from the backup source. 3. If the backup source is a video file, each time the video is finished, the system will check if the primary source is recovered and will switch back if it is.

setBackupSourceType

public void setBackupSourceType(String BackupSourceType)

Set The backup source type. PullLivePushLive: Live streaming PullVodPushLive: Video files Notes: 1. Backup sources are supported only if the primary source type is live streaming. 2. When pull from the primary source is interrupted, the system will pull from the backup source. 3. If the backup source is a video file, each time the video is finished, the system will check if the primary source is recovered and will switch back if it is.

Parameters:

BackupSourceType - The backup source type. PullLivePushLive: Live streaming PullVodPushLive: Video files Notes: 1. Backup sources are supported only if the primary source type is live streaming. 2. When pull from the primary source is interrupted, the system will pull from the backup source. 3. If the backup source is a video file, each time the video is finished, the system will check if the primary source is recovered and will switch back if it is.

getBackupSourceUrl

public String getBackupSourceUrl()

Get The URL of the backup source. You can specify only one backup source URL.

Returns:

BackupSourceUrl The URL of the backup source. You can specify only one backup source URL.

setBackupSourceUrl

public void setBackupSourceUrl(String BackupSourceUrl)

Set The URL of the backup source. You can specify only one backup source URL.

Parameters:

BackupSourceUrl - The URL of the backup source. You can specify only one backup source URL.

getWatermarkList

public PullPushWatermarkInfo[] getWatermarkList()

Get The information of watermarks to add. Notes: 1. You can add up to four watermarks to different locations of the video. 2. Make sure you use publicly accessible URLs for the watermark images. 3. Supported image formats include PNG, JPG, and GIF.

Returns:

WatermarkList The information of watermarks to add. Notes: 1. You can add up to four watermarks to different locations of the video. 2. Make sure you use publicly accessible URLs for the watermark images. 3. Supported image formats include PNG, JPG, and GIF.

setWatermarkList

public void setWatermarkList(PullPushWatermarkInfo[] WatermarkList)

Set The information of watermarks to add. Notes: 1. You can add up to four watermarks to different locations of the video. 2. Make sure you use publicly accessible URLs for the watermark images. 3. Supported image formats include PNG, JPG, and GIF.

Parameters:

WatermarkList - The information of watermarks to add. Notes: 1. You can add up to four watermarks to different locations of the video. 2. Make sure you use publicly accessible URLs for the watermark images. 3. Supported image formats include PNG, JPG, and GIF.

getVodLocalMode

public Long getVodLocalMode()

Get Whether to use local mode when the source type is video files. The default is `0`. 0: Do not use local mode 1: Use local mode Note: If you enable local mode, MP4 files will be downloaded to local storage, and the local files will be used for push. This ensures more reliable push. Pushing a local file will incur additional fees.

Returns:

VodLocalMode Whether to use local mode when the source type is video files. The default is `0`. 0: Do not use local mode 1: Use local mode Note: If you enable local mode, MP4 files will be downloaded to local storage, and the local files will be used for push. This ensures more reliable push. Pushing a local file will incur additional fees.

setVodLocalMode

public void setVodLocalMode(Long VodLocalMode)

Set Whether to use local mode when the source type is video files. The default is `0`. 0: Do not use local mode 1: Use local mode Note: If you enable local mode, MP4 files will be downloaded to local storage, and the local files will be used for push. This ensures more reliable push. Pushing a local file will incur additional fees.

Parameters:

VodLocalMode - Whether to use local mode when the source type is video files. The default is `0`. 0: Do not use local mode 1: Use local mode Note: If you enable local mode, MP4 files will be downloaded to local storage, and the local files will be used for push. This ensures more reliable push. Pushing a local file will incur additional fees.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel