public class PullStreamTaskInfo extends AbstractModel
header, skipSign
Constructor and Description |
---|
PullStreamTaskInfo() |
PullStreamTaskInfo(PullStreamTaskInfo 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.
|
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 |
getBackupToUrl()
Get Newly added streaming address.
|
String[] |
getCallbackEvents()
Get The events to listen for.
|
String |
getCallbackInfo()
Get Note: This parameter is not returned currently.
|
String |
getCallbackUrl()
Get The callback URL.
|
String |
getComment()
Get The remarks for the task.
|
String |
getCreateBy()
Get The task creator.
|
String |
getCreateTime()
Get The task creation time.
|
String |
getDomainName()
Get The push domain name.
|
String |
getEndTime()
Get The end time.
|
String |
getErrorInfo()
Get Note: This parameter is not returned currently.
|
String |
getPushArgs()
Get The push parameter.
|
RecentPullInfo |
getRecentPullInfo()
Get Note: This parameter is returned only if one task is queried.
|
String |
getRecordTemplateId()
Get Recording template ID.
|
String |
getRegion()
Get The region where the task was created.
|
String |
getSourceType()
Get The source type.
|
String[] |
getSourceUrls()
Get The source URL(s).
|
String |
getStartTime()
Get The start time.
|
String |
getStatus()
Get The task status.
|
String |
getStreamName()
Get The stream name.
|
String |
getTaskId()
Get The task ID.
|
String |
getUpdateBy()
Get The operator of the last update.
|
String |
getUpdateTime()
Get The last updated time.
|
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 |
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 |
setBackupToUrl(String BackupToUrl)
Set Newly added streaming address.
|
void |
setCallbackEvents(String[] CallbackEvents)
Set The events to listen for.
|
void |
setCallbackInfo(String CallbackInfo)
Set Note: This parameter is not returned currently.
|
void |
setCallbackUrl(String CallbackUrl)
Set The callback URL.
|
void |
setComment(String Comment)
Set The remarks for the task.
|
void |
setCreateBy(String CreateBy)
Set The task creator.
|
void |
setCreateTime(String CreateTime)
Set The task creation time.
|
void |
setDomainName(String DomainName)
Set The push domain name.
|
void |
setEndTime(String EndTime)
Set The end time.
|
void |
setErrorInfo(String ErrorInfo)
Set Note: This parameter is not returned currently.
|
void |
setPushArgs(String PushArgs)
Set The push parameter.
|
void |
setRecentPullInfo(RecentPullInfo RecentPullInfo)
Set Note: This parameter is returned only if one task is queried.
|
void |
setRecordTemplateId(String RecordTemplateId)
Set Recording template ID.
|
void |
setRegion(String Region)
Set The region where the task was created.
|
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 |
setStatus(String Status)
Set The task status.
|
void |
setStreamName(String StreamName)
Set The stream name.
|
void |
setTaskId(String TaskId)
Set The task ID.
|
void |
setUpdateBy(String UpdateBy)
Set The operator of the last update.
|
void |
setUpdateTime(String UpdateTime)
Set The last updated time.
|
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.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public PullStreamTaskInfo()
public PullStreamTaskInfo(PullStreamTaskInfo source)
public String getTaskId()
public void setTaskId(String TaskId)
TaskId
- The task ID.public String getSourceType()
public void setSourceType(String SourceType)
SourceType
- The source type. Valid values:
PullLivePushLive: Live streaming
PullVodPushLive: Video files
PullPicPushLive: Imagespublic String[] getSourceUrls()
public void setSourceUrls(String[] SourceUrls)
SourceUrls
- The source URL(s).
If `SourceType` is `PullLiveToLive`, there can be only one source URL.
If `SourceType` is `PullVodToLive`, there can be at most 10 source URLs.public String getDomainName()
public void setDomainName(String DomainName)
DomainName
- The push domain name.
The pulled stream is pushed to this domain.public String getAppName()
public void setAppName(String AppName)
AppName
- The application to push to.
The pulled stream is pushed to this application.public String getStreamName()
public void setStreamName(String StreamName)
StreamName
- The stream name.
The pulled stream is pushed under this name.public String getPushArgs()
public void setPushArgs(String PushArgs)
PushArgs
- The push parameter.
A custom push parameter.public String getStartTime()
public void setStartTime(String StartTime)
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.public String getEndTime()
public void setEndTime(String EndTime)
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.public String getRegion()
public void setRegion(String Region)
Region
- The region where the task was created.
`ap-beijing`: North China (Beijing)
`ap-shanghai`: East China (Shanghai)
`ap-guangzhou`: South China (Guangzhou)
`ap-mumbai`: India
`ap-hongkong`: Hong Kong
`eu-frankfurt`: Germany
`ap-seoul`: Korea
`ap-bangkok`: Thailand
`ap-singapore`: Singapore
`na-siliconvalley`: Western US
`na-ashburn`: Eastern US
`ap-tokyo`: Japanpublic Long getVodLoopTimes()
public void setVodLoopTimes(Long VodLoopTimes)
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.public String getVodRefreshType()
public void setVodRefreshType(String VodRefreshType)
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.public String getCreateTime()
public void setCreateTime(String CreateTime)
CreateTime
- The task creation 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.public String getUpdateTime()
public void setUpdateTime(String UpdateTime)
UpdateTime
- The last updated 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.public String getCreateBy()
public void setCreateBy(String CreateBy)
CreateBy
- The task creator.public String getUpdateBy()
public void setUpdateBy(String UpdateBy)
UpdateBy
- The operator of the last update.public String getCallbackUrl()
public void setCallbackUrl(String CallbackUrl)
CallbackUrl
- The callback URL.public String[] getCallbackEvents()
public void setCallbackEvents(String[] CallbackEvents)
CallbackEvents
- The events to listen 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 taskpublic String getCallbackInfo()
public void setCallbackInfo(String CallbackInfo)
CallbackInfo
- Note: This parameter is not returned currently.
The information of the last callback.public String getErrorInfo()
public void setErrorInfo(String ErrorInfo)
ErrorInfo
- Note: This parameter is not returned currently.
Error message.public String getStatus()
public void setStatus(String Status)
Status
- The task status.
enable: Enabled
pause: Pausedpublic RecentPullInfo getRecentPullInfo()
public void setRecentPullInfo(RecentPullInfo RecentPullInfo)
RecentPullInfo
- Note: This parameter is returned only if one task is queried.
The latest pull information.
The information includes the source URL, offset, and report time.public String getComment()
public void setComment(String Comment)
Comment
- The remarks for the task.public String getBackupSourceType()
public void setBackupSourceType(String BackupSourceType)
BackupSourceType
- The backup source type. Valid values:
PullLivePushLive: Live streaming
PullVodPushLive: Video files
Note: This field may return null, indicating that no valid values can be obtained.public String getBackupSourceUrl()
public void setBackupSourceUrl(String BackupSourceUrl)
BackupSourceUrl
- The URL of the backup source.
Note: This field may return null, indicating that no valid values can be obtained.public PullPushWatermarkInfo[] getWatermarkList()
public void setWatermarkList(PullPushWatermarkInfo[] WatermarkList)
WatermarkList
- The information of watermarks to add.
Note: This field may return null, indicating that no valid values can be obtained.public Long getVodLocalMode()
public void setVodLocalMode(Long VodLocalMode)
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: This field may return null, indicating that no valid values can be obtained.public String getRecordTemplateId()
public void setRecordTemplateId(String RecordTemplateId)
RecordTemplateId
- Recording template ID.public String getBackupToUrl()
public void setBackupToUrl(String BackupToUrl)
BackupToUrl
- Newly added streaming address. Used for the scenario of pushing two streams with a single task.Copyright © 2024. All rights reserved.