public class CreateLivePullStreamTaskRequest extends AbstractModel
header, skipSign
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.
|
Modifier and Type | Method and Description |
---|---|
String |
getAppName()
Get 推流路径。
将拉取过来的流推到该路径。
|
String |
getBackupSourceType()
Get 备源的类型:
PullLivePushLive -直播,
PullVodPushLive -点播。
注意:
1.
|
String |
getBackupSourceUrl()
Get 备源 URL。
只允许填一个备源 URL
|
String |
getBackupToUrl()
Get 新的目标地址,用于任务同时推两路场景。
|
String[] |
getCallbackEvents()
Get 选择需要回调的事件(不填则回调全部):
TaskStart:任务启动回调,
TaskExit:任务停止回调,
VodSourceFileStart:从点播源文件开始拉流回调,
VodSourceFileFinish:从点播源文件拉流结束回调,
ResetTaskConfig:任务更新回调。
TaskAlarm: 用于告警事件通知,AlarmType 示例:
PullFileUnstable - 文件拉取不稳定,
PushStreamUnstable - 推流不稳定,
PullFileFailed - 文件拉取出错,
PushStreamFailed - 推流出现失败,
FileEndEarly - 文件提前结束。
|
String |
getCallbackUrl()
Get 自定义回调地址。
拉流转推任务相关事件会回调到该地址。
回调事件使用方法请查看:
https://cloud.tencent.com/document/product/267/32744
https://cloud.tencent.com/document/product/267/56208
|
String |
getComment()
Get 任务描述,限制 512 字节。
|
String |
getDomainName()
Get 推流域名。
将拉取过来的流推到该域名。
注意:如果目标地址为非云直播,且样式不同于云直播,请使用 ToUrl 传入完整推流地址,详细用法请参考 ToUrl 参数说明。
|
String |
getEndTime()
Get 结束时间,注意:
1.
|
String |
getExtraCmd()
Get 其他参数。
示例: ignore_region 用于忽略传入地域, 内部按负载分配。
|
String |
getOperator()
Get 任务操作人备注。
|
String |
getPushArgs()
Get 推流参数。
推流时携带自定义参数。
示例:
bak=1&test=2 。
|
String |
getRecordTemplateId()
Get 录制模板 ID。
|
String |
getSourceType()
Get 拉流源的类型:
PullLivePushLive -直播,
PullVodPushLive -点播,
PullPicPushLive -图片。
|
String[] |
getSourceUrls()
Get 拉流源 url 列表。
SourceType 为直播(PullLivePushLive)只可以填1个,
SourceType 为点播(PullVodPushLive)可以填多个,上限30个。
当前支持的文件格式:flv,mp4,hls。
当前支持的拉流协议:http,https,rtmp,rtmps,rtsp,srt。
注意:
1.
|
String |
getSpecifyTaskId()
Get 自定义任务 ID。
注:
1.
|
String |
getStartTime()
Get 开始时间。
使用 UTC 格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时。
|
String |
getStreamName()
Get 推流名称。
将拉取过来的流推到该流名称。
|
String |
getToUrl()
Get 完整目标 URL 地址。
用法注意:如果使用该参数来传完整目标地址,则 DomainName, AppName, StreamName 需要传入空字符串,任务将会使用该 ToUrl 参数指定的目标地址。
使用该方式传入目标地址支持的协议有:
rtmp、rtmps、rtsp、rtp、srt。
注意:签名时间需要超过任务结束时间,避免因签名过期造成任务失败。
|
String |
getTranscodeTemplateName()
Get 直播转码模板,使用云直播的转码功能进行转码后再转推出去。转码模板需在云直播控制台创建。
|
Long |
getVodLocalMode()
Get 点播源是否启用本地推流模式,默认0,不启用。
0 - 不启用。
1 - 启用。
注意:启用本地模式后,会将源列表中的 MP4 文件进行本地下载,优先使用本地已下载文件进行推流,提高点播源推流稳定性。使用本地下载文件推流时,会产生增值费用。
|
String |
getVodLoopTimes()
Get 点播拉流转推循环次数。默认:-1。
-1:无限循环,直到任务结束。
0:不循环。
>0:具体循环次数。次数和时间以先结束的为准。
注意:该配置仅对拉流源为点播时生效。
|
String |
getVodRefreshType()
Get 点播更新SourceUrls后的播放方式:
ImmediateNewSource:立即播放新的拉流源内容;
ContinueBreakPoint:播放完当前正在播放的点播 url 后再使用新的拉流源播放。(旧拉流源未播放的点播 url 不会再播放)
注意:该配置生效仅对变更前拉流源为点播时生效。
|
PullPushWatermarkInfo[] |
getWatermarkList()
Get 水印信息列表。
注意:
1.
|
void |
setAppName(String AppName)
Set 推流路径。
将拉取过来的流推到该路径。
|
void |
setBackupSourceType(String BackupSourceType)
Set 备源的类型:
PullLivePushLive -直播,
PullVodPushLive -点播。
注意:
1.
|
void |
setBackupSourceUrl(String BackupSourceUrl)
Set 备源 URL。
只允许填一个备源 URL
|
void |
setBackupToUrl(String BackupToUrl)
Set 新的目标地址,用于任务同时推两路场景。
|
void |
setCallbackEvents(String[] CallbackEvents)
Set 选择需要回调的事件(不填则回调全部):
TaskStart:任务启动回调,
TaskExit:任务停止回调,
VodSourceFileStart:从点播源文件开始拉流回调,
VodSourceFileFinish:从点播源文件拉流结束回调,
ResetTaskConfig:任务更新回调。
TaskAlarm: 用于告警事件通知,AlarmType 示例:
PullFileUnstable - 文件拉取不稳定,
PushStreamUnstable - 推流不稳定,
PullFileFailed - 文件拉取出错,
PushStreamFailed - 推流出现失败,
FileEndEarly - 文件提前结束。
|
void |
setCallbackUrl(String CallbackUrl)
Set 自定义回调地址。
拉流转推任务相关事件会回调到该地址。
回调事件使用方法请查看:
https://cloud.tencent.com/document/product/267/32744
https://cloud.tencent.com/document/product/267/56208
|
void |
setComment(String Comment)
Set 任务描述,限制 512 字节。
|
void |
setDomainName(String DomainName)
Set 推流域名。
将拉取过来的流推到该域名。
注意:如果目标地址为非云直播,且样式不同于云直播,请使用 ToUrl 传入完整推流地址,详细用法请参考 ToUrl 参数说明。
|
void |
setEndTime(String EndTime)
Set 结束时间,注意:
1.
|
void |
setExtraCmd(String ExtraCmd)
Set 其他参数。
示例: ignore_region 用于忽略传入地域, 内部按负载分配。
|
void |
setOperator(String Operator)
Set 任务操作人备注。
|
void |
setPushArgs(String PushArgs)
Set 推流参数。
推流时携带自定义参数。
示例:
bak=1&test=2 。
|
void |
setRecordTemplateId(String RecordTemplateId)
Set 录制模板 ID。
|
void |
setSourceType(String SourceType)
Set 拉流源的类型:
PullLivePushLive -直播,
PullVodPushLive -点播,
PullPicPushLive -图片。
|
void |
setSourceUrls(String[] SourceUrls)
Set 拉流源 url 列表。
SourceType 为直播(PullLivePushLive)只可以填1个,
SourceType 为点播(PullVodPushLive)可以填多个,上限30个。
当前支持的文件格式:flv,mp4,hls。
当前支持的拉流协议:http,https,rtmp,rtmps,rtsp,srt。
注意:
1.
|
void |
setSpecifyTaskId(String SpecifyTaskId)
Set 自定义任务 ID。
注:
1.
|
void |
setStartTime(String StartTime)
Set 开始时间。
使用 UTC 格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时。
|
void |
setStreamName(String StreamName)
Set 推流名称。
将拉取过来的流推到该流名称。
|
void |
setToUrl(String ToUrl)
Set 完整目标 URL 地址。
用法注意:如果使用该参数来传完整目标地址,则 DomainName, AppName, StreamName 需要传入空字符串,任务将会使用该 ToUrl 参数指定的目标地址。
使用该方式传入目标地址支持的协议有:
rtmp、rtmps、rtsp、rtp、srt。
注意:签名时间需要超过任务结束时间,避免因签名过期造成任务失败。
|
void |
setTranscodeTemplateName(String TranscodeTemplateName)
Set 直播转码模板,使用云直播的转码功能进行转码后再转推出去。转码模板需在云直播控制台创建。
|
void |
setVodLocalMode(Long VodLocalMode)
Set 点播源是否启用本地推流模式,默认0,不启用。
0 - 不启用。
1 - 启用。
注意:启用本地模式后,会将源列表中的 MP4 文件进行本地下载,优先使用本地已下载文件进行推流,提高点播源推流稳定性。使用本地下载文件推流时,会产生增值费用。
|
void |
setVodLoopTimes(String VodLoopTimes)
Set 点播拉流转推循环次数。默认:-1。
-1:无限循环,直到任务结束。
0:不循环。
>0:具体循环次数。次数和时间以先结束的为准。
注意:该配置仅对拉流源为点播时生效。
|
void |
setVodRefreshType(String VodRefreshType)
Set 点播更新SourceUrls后的播放方式:
ImmediateNewSource:立即播放新的拉流源内容;
ContinueBreakPoint:播放完当前正在播放的点播 url 后再使用新的拉流源播放。(旧拉流源未播放的点播 url 不会再播放)
注意:该配置生效仅对变更前拉流源为点播时生效。
|
void |
setWatermarkList(PullPushWatermarkInfo[] WatermarkList)
Set 水印信息列表。
注意:
1.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public CreateLivePullStreamTaskRequest()
public CreateLivePullStreamTaskRequest(CreateLivePullStreamTaskRequest source)
public String getSourceType()
public void setSourceType(String SourceType)
SourceType
- 拉流源的类型:
PullLivePushLive -直播,
PullVodPushLive -点播,
PullPicPushLive -图片。public String[] getSourceUrls()
public void setSourceUrls(String[] SourceUrls)
SourceUrls
- 拉流源 url 列表。
SourceType 为直播(PullLivePushLive)只可以填1个,
SourceType 为点播(PullVodPushLive)可以填多个,上限30个。
当前支持的文件格式:flv,mp4,hls。
当前支持的拉流协议:http,https,rtmp,rtmps,rtsp,srt。
注意:
1. 建议优先使用 flv 文件,对于 mp4 未交织好的文件轮播推流易产生卡顿,可通过点播转码进行重新交织后再轮播。
2. 拒绝内网域名等攻击性拉流地址,如有使用,则做账号封禁处理。
3. 源文件请保持时间戳正常交织递增,避免因源文件异常影响推流及播放。
4. 视频编码格式仅支持: H264, H265。
5. 音频编码格式仅支持: AAC。
6. 点播源请使用小文件,尽量时长保持在1小时内,较大文件打开和续播耗时较久,耗时超过15秒会有无法正常转推风险。
7. 避免使用低频存储的文件,该类文件因低频存储,拉取时容易出现慢速,影响拉转推质量。public String getDomainName()
public void setDomainName(String DomainName)
DomainName
- 推流域名。
将拉取过来的流推到该域名。
注意:如果目标地址为非云直播,且样式不同于云直播,请使用 ToUrl 传入完整推流地址,详细用法请参考 ToUrl 参数说明。public String getAppName()
public void setAppName(String AppName)
AppName
- 推流路径。
将拉取过来的流推到该路径。public String getStreamName()
public void setStreamName(String StreamName)
StreamName
- 推流名称。
将拉取过来的流推到该流名称。public String getStartTime()
public void setStartTime(String StartTime)
StartTime
- 开始时间。
使用 UTC 格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时。public String getEndTime()
public void setEndTime(String EndTime)
EndTime
- 结束时间,注意:
1. 结束时间必须大于开始时间;
2. 结束时间必须大于当前时间;
3. 结束时间 和 开始时间 间隔必须小于七天。
使用 UTC 格式时间,
例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时。public String getOperator()
public void setOperator(String Operator)
Operator
- 任务操作人备注。public String getPushArgs()
public void setPushArgs(String PushArgs)
PushArgs
- 推流参数。
推流时携带自定义参数。
示例:
bak=1&test=2 。public String[] getCallbackEvents()
public void setCallbackEvents(String[] CallbackEvents)
CallbackEvents
- 选择需要回调的事件(不填则回调全部):
TaskStart:任务启动回调,
TaskExit:任务停止回调,
VodSourceFileStart:从点播源文件开始拉流回调,
VodSourceFileFinish:从点播源文件拉流结束回调,
ResetTaskConfig:任务更新回调。
TaskAlarm: 用于告警事件通知,AlarmType 示例:
PullFileUnstable - 文件拉取不稳定,
PushStreamUnstable - 推流不稳定,
PullFileFailed - 文件拉取出错,
PushStreamFailed - 推流出现失败,
FileEndEarly - 文件提前结束。public String getVodLoopTimes()
public void setVodLoopTimes(String VodLoopTimes)
VodLoopTimes
- 点播拉流转推循环次数。默认:-1。
-1:无限循环,直到任务结束。
0:不循环。
>0:具体循环次数。次数和时间以先结束的为准。
注意:该配置仅对拉流源为点播时生效。public String getVodRefreshType()
public void setVodRefreshType(String VodRefreshType)
VodRefreshType
- 点播更新SourceUrls后的播放方式:
ImmediateNewSource:立即播放新的拉流源内容;
ContinueBreakPoint:播放完当前正在播放的点播 url 后再使用新的拉流源播放。(旧拉流源未播放的点播 url 不会再播放)
注意:该配置生效仅对变更前拉流源为点播时生效。public String getCallbackUrl()
public void setCallbackUrl(String CallbackUrl)
CallbackUrl
- 自定义回调地址。
拉流转推任务相关事件会回调到该地址。
回调事件使用方法请查看:
https://cloud.tencent.com/document/product/267/32744
https://cloud.tencent.com/document/product/267/56208public String getExtraCmd()
public void setExtraCmd(String ExtraCmd)
ExtraCmd
- 其他参数。
示例: ignore_region 用于忽略传入地域, 内部按负载分配。public String getSpecifyTaskId()
public void setSpecifyTaskId(String SpecifyTaskId)
SpecifyTaskId
- 自定义任务 ID。
注:
1. 该自定义 ID 为可选参数,如果传入,请确保该账号下传入的 ID 唯一。
2. 该自定义 ID 用于防止重复发起请求时产生重复任务。后面也可以用 SpecifyTaskId 来修改或删除任务。public String getComment()
public void setComment(String Comment)
Comment
- 任务描述,限制 512 字节。public String getToUrl()
public void setToUrl(String ToUrl)
ToUrl
- 完整目标 URL 地址。
用法注意:如果使用该参数来传完整目标地址,则 DomainName, AppName, StreamName 需要传入空字符串,任务将会使用该 ToUrl 参数指定的目标地址。
使用该方式传入目标地址支持的协议有:
rtmp、rtmps、rtsp、rtp、srt。
注意:签名时间需要超过任务结束时间,避免因签名过期造成任务失败。public String getBackupSourceType()
public void setBackupSourceType(String BackupSourceType)
BackupSourceType
- 备源的类型:
PullLivePushLive -直播,
PullVodPushLive -点播。
注意:
1. 仅当主源类型为直播源时,备源才会生效。
2. 主直播源拉流中断时,自动使用备源进行拉流。
3. 如果备源为点播文件时,则每次轮播完点播文件就检查主源是否恢复,如果主源恢复则自动切回到主源,否则继续拉备源。public String getBackupSourceUrl()
public void setBackupSourceUrl(String BackupSourceUrl)
BackupSourceUrl
- 备源 URL。
只允许填一个备源 URLpublic PullPushWatermarkInfo[] getWatermarkList()
public void setWatermarkList(PullPushWatermarkInfo[] WatermarkList)
WatermarkList
- 水印信息列表。
注意:
1. 最多支持4个不同位置的水印。
2. 水印图片 URL 请使用合法外网可访问地址。
3. 支持的水印图片格式:png,jpg,gif 等。public Long getVodLocalMode()
public void setVodLocalMode(Long VodLocalMode)
VodLocalMode
- 点播源是否启用本地推流模式,默认0,不启用。
0 - 不启用。
1 - 启用。
注意:启用本地模式后,会将源列表中的 MP4 文件进行本地下载,优先使用本地已下载文件进行推流,提高点播源推流稳定性。使用本地下载文件推流时,会产生增值费用。public String getRecordTemplateId()
public void setRecordTemplateId(String RecordTemplateId)
RecordTemplateId
- 录制模板 ID。public String getBackupToUrl()
public void setBackupToUrl(String BackupToUrl)
BackupToUrl
- 新的目标地址,用于任务同时推两路场景。public String getTranscodeTemplateName()
public void setTranscodeTemplateName(String TranscodeTemplateName)
TranscodeTemplateName
- 直播转码模板,使用云直播的转码功能进行转码后再转推出去。转码模板需在云直播控制台创建。Copyright © 2024. All rights reserved.