com.tencentcloudapi.live.v20180801.models

Class ModifyLivePullStreamTaskRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.live.v20180801.models.ModifyLivePullStreamTaskRequest

public class ModifyLivePullStreamTaskRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ModifyLivePullStreamTaskRequest()
ModifyLivePullStreamTaskRequest(ModifyLivePullStreamTaskRequest 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	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 the task.
String	getEndTime() Get The end time.
Long	getFileIndex() Get The index of the video to start from.
Long	getOffsetTime() Get The playback offset (seconds).
String	getOperator() Get The operator.
String[]	getSourceUrls() Get The source URL(s).
String	getStartTime() Get The start time.
String	getStatus() Get Whether to enable or pause the task.
String	getTaskId() Get The task ID.
Long	getVodLocalMode() Get Whether to use local mode when the source type is video files.
Long	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	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 the task.
void	setEndTime(String EndTime) Set The end time.
void	setFileIndex(Long FileIndex) Set The index of the video to start from.
void	setOffsetTime(Long OffsetTime) Set The playback offset (seconds).
void	setOperator(String Operator) Set The operator.
void	setSourceUrls(String[] SourceUrls) Set The source URL(s).
void	setStartTime(String StartTime) Set The start time.
void	setStatus(String Status) Set Whether to enable or pause the task.
void	setTaskId(String TaskId) Set The task ID.
void	setVodLocalMode(Long VodLocalMode) Set Whether to use local mode when the source type is video files.
void	setVodLoopTimes(Long 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

ModifyLivePullStreamTaskRequest

public ModifyLivePullStreamTaskRequest()

ModifyLivePullStreamTaskRequest

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

getTaskId

public String getTaskId()

Get The task ID.

Returns:

TaskId The task ID.

setTaskId

public void setTaskId(String TaskId)

Set The task ID.

Parameters:

TaskId - The task ID.

getOperator

public String getOperator()

Get The operator.

Returns:

Operator The operator.

setOperator

public void setOperator(String Operator)

Set The operator.

Parameters:

Operator - The operator.

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.

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.

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.

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.

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.

getVodLoopTimes

public Long getVodLoopTimes()

Get The number of times to loop video files. -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 if the source is video files.

Returns:

VodLoopTimes The number of times to loop video files. -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 if the source is video files.

setVodLoopTimes

public void setVodLoopTimes(Long VodLoopTimes)

Set The number of times to loop video files. -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 if the source is video files.

Parameters:

VodLoopTimes - The number of times to loop video files. -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 if 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: Finish the current video first and then pull from the new source. This parameter is valid only if the source is video files.

Returns:

VodRefreshType The behavior after the source video files (`SourceUrls`) are changed. ImmediateNewSource: Play the new videos immediately ContinueBreakPoint: Finish the current video first and then pull from the new source. This parameter is valid only if the source 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: Finish the current video first and then pull from the new source. This parameter is valid only if the source is video files.

Parameters:

VodRefreshType - The behavior after the source video files (`SourceUrls`) are changed. ImmediateNewSource: Play the new videos immediately ContinueBreakPoint: Finish the current video first and then pull from the new source. This parameter is valid only if the source is video files.

getStatus

public String getStatus()

Get Whether to enable or pause the task. Valid values: enable pause

Returns:

Status Whether to enable or pause the task. Valid values: enable pause

setStatus

public void setStatus(String Status)

Set Whether to enable or pause the task. Valid values: enable pause

Parameters:

Status - Whether to enable or pause the task. Valid values: enable pause

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

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

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

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

getCallbackUrl

public String getCallbackUrl()

Get A custom callback URL. Callbacks will be sent to this URL.

Returns:

CallbackUrl A custom callback URL. Callbacks will be sent to this URL.

setCallbackUrl

public void setCallbackUrl(String CallbackUrl)

Set A custom callback URL. Callbacks will be sent to this URL.

Parameters:

CallbackUrl - A custom callback URL. Callbacks will be sent to this URL.

getFileIndex

public Long getFileIndex()

Get The index of the video to start from. The value of this parameter cannot be smaller than 1 or larger than the number of elements in `SourceUrls`.

Returns:

FileIndex The index of the video to start from. The value of this parameter cannot be smaller than 1 or larger than the number of elements in `SourceUrls`.

setFileIndex

public void setFileIndex(Long FileIndex)

Set The index of the video to start from. The value of this parameter cannot be smaller than 1 or larger than the number of elements in `SourceUrls`.

Parameters:

FileIndex - The index of the video to start from. The value of this parameter cannot be smaller than 1 or larger than the number of elements in `SourceUrls`.

getOffsetTime

public Long getOffsetTime()

Get The playback offset (seconds). Notes: 1. This parameter should be used together with `FileIndex`.

Returns:

OffsetTime The playback offset (seconds). Notes: 1. This parameter should be used together with `FileIndex`.

setOffsetTime

public void setOffsetTime(Long OffsetTime)

Set The playback offset (seconds). Notes: 1. This parameter should be used together with `FileIndex`.

Parameters:

OffsetTime - The playback offset (seconds). Notes: 1. This parameter should be used together with `FileIndex`.

getComment

public String getComment()

Get The remarks for the task.

Returns:

Comment The remarks for the task.

setComment

public void setComment(String Comment)

Set The remarks for the task.

Parameters:

Comment - The remarks for the task.

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. Leaving this parameter empty will reset the backup source. 3. When pull from the primary source is interrupted, the system will pull from the backup source. 4. 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. Leaving this parameter empty will reset the backup source. 3. When pull from the primary source is interrupted, the system will pull from the backup source. 4. 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. Leaving this parameter empty will reset the backup source. 3. When pull from the primary source is interrupted, the system will pull from the backup source. 4. 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. Leaving this parameter empty will reset the backup source. 3. When pull from the primary source is interrupted, the system will pull from the backup source. 4. 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 and JPG. 4. If you change the watermark configuration of a task whose source is a list of video files, the new configuration will take effect for the next file in the list. 5. If you change the watermark configuration of a task whose source is a live stream, the new configuration will take effect immediately. 6. If you want to stop using watermarks, pass in an empty array. 7. Currently, animated watermarks are not supported.

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 and JPG. 4. If you change the watermark configuration of a task whose source is a list of video files, the new configuration will take effect for the next file in the list. 5. If you change the watermark configuration of a task whose source is a live stream, the new configuration will take effect immediately. 6. If you want to stop using watermarks, pass in an empty array. 7. Currently, animated watermarks are not supported.

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 and JPG. 4. If you change the watermark configuration of a task whose source is a list of video files, the new configuration will take effect for the next file in the list. 5. If you change the watermark configuration of a task whose source is a live stream, the new configuration will take effect immediately. 6. If you want to stop using watermarks, pass in an empty array. 7. Currently, animated watermarks are not supported.

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 and JPG. 4. If you change the watermark configuration of a task whose source is a list of video files, the new configuration will take effect for the next file in the list. 5. If you change the watermark configuration of a task whose source is a live stream, the new configuration will take effect immediately. 6. If you want to stop using watermarks, pass in an empty array. 7. Currently, animated watermarks are not supported.

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