tencent cloud

APIs

ドキュメントAPIsStreamLinkData Types

Data Types

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-13 10:59:47

CreateInput

Create input configuration message.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput.

Name Type Required Description
InputName String Yes Enter a name. It can contain uppercase letters, lowercase letters, digits, and underscores. Length: [1, 32].
Protocol String Yes Input protocol. Selectable: [SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST].
Description String No Enter description. Length: [0, 255].
AllowIpList Array of String No Input IP allowlist in CIDR format.
SRTSettings CreateInputSRTSettings No SRT configuration information of the input.
RTPSettings CreateInputRTPSettings No Input RTP configuration message.
FailOver String No Primary/replica switch input. Selectable values: OPEN and CLOSE. Default value: CLOSE.
RTMPPullSettings CreateInputRTMPPullSettings No Input RTMP_PULL configuration message.
RTSPPullSettings CreateInputRTSPPullSettings No Input RTSP_PULL configuration message.
HLSPullSettings CreateInputHLSPullSettings No Input HLS_PULL configuration message.
ResilientStream ResilientStreamConf No Configuration message for smooth streaming during delayed broadcasting.
SecurityGroupIds Array of String No Bound input security group ID.
Zones Array of String No Availability zone. This parameter is optional. If disaster recovery is enabled, two different availability zones must be input. Otherwise, only one availability zone can be input.
RISTSettings CreateInputRISTSettings No Input RIST configuration message.
InputRegion String No Region of the input node
FailOverOption FailOverOption No Hot/cold backup

CreateInputHLSPullSettings

Configuration message of the created input HLS pull.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
SourceAddresses Array of HLSPullSourceAddress Yes HLS origin server address. Only one is allowed.

CreateInputRISTSettings

Input RIST configuration message created.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Mode String No RIST mode. Valid value: LISTENER. Default value: LISTENER.
Profile String No RIST configuration solution. Options: [MAIN|SIMPLE]. Default: MAIN.
Buffer Integer No RIST buffer size in milliseconds. Minimum value: 50 ms. Maximum value: 5000 ms. Default value: 120.

CreateInputRTMPPullSettings

Configuration message of the created input RTMP pull.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
SourceAddresses Array of RTMPPullSourceAddress Yes RTMP origin server address. Only one is allowed.

CreateInputRTPSettings

Configuration message for creating an input RTP.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
FEC String No Default value: "none". Available value: ['none'].
IdleTimeout Integer No Idle timeout. Default value: 5000 ms. Range: [1000, 10000].

CreateInputRTSPPullSettings

Configuration message of the created input RTSP pull stream.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
SourceAddresses Array of RTSPPullSourceAddress Yes Origin server address of the RTSP origin server. Only one is allowed.

CreateInputSRTSettings

Configuration message of the created input SRT.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Mode String No SRT mode. Options: [LISTENER|CALLER]. Default value: LISTENER.
StreamId String No Stream Id. It can contain upper- and lower-case letters, digits, and special characters (.#!:&,=_-), with a length of 0 to 512. For the specific format, see: https://github.com/Haivision/srt/blob/master/docs/features/access-control.md#standard-keys.
Latency Integer No Delay. Default value: 0. Unit: ms. Range: [0, 3000].
RecvLatency Integer No Receive latency. Default value: 120. Unit: ms. Range: [0, 3000].
PeerLatency Integer No Peer delay. Default value: 0. Unit: ms. Range: [0, 3000].
PeerIdleTimeout Integer No Peer timeout. Default value: 5000 ms. Range: [1000, 10000].
Passphrase String No Decryption key. Empty by default, which means not encrypted. Only ascii characters are supported. Length range: [10, 79].
PbKeyLen Integer No Key length. Default value: 0. Options: [0|16|24|32].
SourceAddresses Array of SRTSourceAddressReq No SRT peer address. Required when Mode is CALLER, and can only contain 1 group.
FEC SRTFECSimpleOptions No SRT FEC settings

CreateOutputInfo

Configuration message for creating an output.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo.

Name Type Required Description
OutputName String Yes Output name.
Description String Yes Output description.
Protocol String Yes Output relay protocol. Supports SRT, RTP, RTMP, RTMP_PULL, RTSP_PULL, and RIST.
OutputRegion String Yes Output region.
SRTSettings CreateOutputSrtSettings No Configuration of the output SRT.
RTMPSettings CreateOutputRTMPSettings No Configuration of the output RTMP.
RTPSettings CreateOutputInfoRTPSettings No Configuration of the output RTP.
AllowIpList Array of String No IP whitelist list in CIDR format, for example, 0.0.0.0/0.
Valid when Protocol is RTMP_PULL. If empty, it represents no limit on client IP.
MaxConcurrent Integer No Maximum number of concurrent stream pulls. Maximum value: 4. Default value: 4.
SecurityGroupIds Array of String No ID of the bound input security group.
Zones Array of String No Availability zone. output supports a maximum of one user-submitted input availability zone.
OutputType String No Output type: Internet/TencentCSS/StreamLive
RISTSettings CreateOutputRistSettings No Output RIST configuration.
OutputKind String No Output module type, including Pinpoint (single-point output, supports up to four concurrent outputs); MultiMesh (multiple streams output, supports more than four concurrent outputs, currently up to 200). The default type is Pinpoint output. For a single Flow, only one MultiMesh output is allowed per zone.
StreamSelector StreamSelector No For streams with multiple audio/video tracks, you can specify the track to be used

CreateOutputInfoRTPSettings

Create the RTP configuration for the output of a media transmission stream.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Destinations Array of CreateOutputRTPSettingsDestinations Yes Destination address. You can enter 1 to 2 addresses.
FEC String Yes Can only be filled in with none.
IdleTimeout Integer Yes Idle timeout period, in milliseconds.

CreateOutputRTMPSettings

RTMP configuration for creating the output of a media transmission stream.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Destinations Array of CreateOutputRtmpSettingsDestinations Yes Target address for repost. You can enter 1 to 2 addresses.
ChunkSize Integer No Chunk size of RTMP, ranging from 4096 to 40960.

CreateOutputRTPSettingsDestinations

Create the RTP destination address for the output of a media transmission stream.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Ip String Yes Destination IP for repush.
Port Integer Yes Destination port for push.

CreateOutputRistSettings

Create the RIST configuration for the output of a media transmission stream.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Mode String No RIST mode. Selectable: [LISTENER|CALLER]. Default: LISTENER.
Profile String No RIST configuration solution. Options: [MAIN|SIMPLE]. Default: MAIN.
Buffer Integer No RIST buffer size in milliseconds. Minimum value: 50 ms. Maximum value: 5000 ms. Default value: 120

CreateOutputRtmpSettingsDestinations

RTMP destination address for creating the output of a media transmission stream.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Url String Yes URL for push forwarding, in the format of rtmp://domain/live.
StreamKey String Yes StreamKey for republishing, in the format of: stream?key=value.

CreateOutputSrtSettings

Create the SRT configuration for the output of a media transmission stream.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Destinations Array of CreateOutputSrtSettingsDestinations Yes Target address for push. Required when Mode is CALLER. Only 1 group can be filled in.
Mode String No SRT mode. Valid values: LISTENER and CALLER. Default value: CALLER.
StreamId String No Stream Id for SRT retransmission. It can contain upper- and lower-case letters, digits, and special characters (.#!:&,=_-), with a length of 0 to 512.
Latency Integer No Total delay for SRT retransmission. Default value: 0. Unit: ms. Range: [0, 3000]. This parameter simultaneously sets the sender and recipient delays (recvlatency and peerlatency) to the same value. Recommended configuration: at least 3 times the RTT to ensure effective handling of packet retransmission and confirmation during network congestion.
RecvLatency Integer No Receive latency for SRT relay. Default value: 120. Unit: ms. Range: [0, 3000].
This parameter indicates the time length for the recipient to cache data packets.
PeerLatency Integer No Peer delay for SRT retransmission. Default value: 0. Unit: ms. Range: [0, 3000].
This parameter is set by the sender to inform the recipient of the expected buffer time for delay.
PeerIdleTimeout Integer No Idle timeout for SRT relay. Default value: 5000 ms. Range: [1000, 10000].
If there is no activity on a connection within the set timeout period, it will be closed.
Passphrase String No Encryption key for SRT retweet. It is empty by default, indicating not encrypted. Only ascii characters are allowed, with a length of [10, 79].
PbKeyLen Integer No Key length for SRT retransmission. Default value: 0. Options: [0|16|24|32].
FEC SRTFECFullOptions No SRT FEC settings

CreateOutputSrtSettingsDestinations

Create the SRT destination address for the output of a media transmission stream.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Ip String Yes Output IP or domain.
Port Integer Yes Output port.

DescribeFlow

Query the Flow configuration information.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkFlow, DescribeStreamLinkFlows.

Name Type Description
FlowId String Stream Id.
FlowName String Stream name.
State String Stream status. Valid values: IDLE, RUNNING.
MaxBandwidth Integer Maximum bandwidth.
InputGroup Array of DescribeInput Input group.
OutputGroup Array of DescribeOutput Output group.
EventId String EventId of the media transmission event associated with this Flow.
CreateTime String Creation time of the Flow in UTC format.
AllowedInputProtocols Array of String Input protocols that can be created for this Flow.
AllowedOutputProtocols Array of String Output protocols allowed to be created by this Flow

DescribeHLSPullSourceAddress

Query input HLS configuration message.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Url String Url of the HLS origin server.

DescribeInput

Query input configuration message.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput.

Name Type Description
InputId String Input Id.
InputName String Input name.
Description String Input description.
Protocol String Input protocol.
InputAddressList Array of InputAddress Input the address list.
AllowIpList Array of String Input the IP whitelist list.
SRTSettings DescribeInputSRTSettings SRT configuration information of the input.
RTPSettings DescribeInputRTPSettings Input RTP configuration message.
InputRegion String Input region.
RTMPSettings DescribeInputRTMPSettings Input RTMP configuration message.
FailOver String Primary/replica switch input.
Zones Array of String Availability zone configuration. In the current situation with disaster recovery enabled, there can be up to two, corresponding to pipeline 0 and 1 in sequence. Otherwise, there is only one availability zone.
RTMPPullSettings DescribeInputRTMPPullSettings Input RTMP_PULL configuration message.
RTSPPullSettings DescribeInputRTSPPullSettings Input RTSP_PULL configuration message.
HLSPullSettings DescribeInputHLSPullSettings Input HLS_PULL configuration message.
ResilientStream ResilientStreamConf Configuration message for smooth streaming during delayed broadcasting.
SecurityGroupIds Array of String Bound input security group ID.
RISTSettings DescribeInputRISTSettings Input RIST configuration message.
StreamUrls Array of StreamUrlDetail Input URL information related to module settings, including the provided streaming address or the configured third-party source stream URL.
FailOverOption FailOverOption Disaster recovery configuration item

DescribeInputHLSPullSettings

Query the configuration message of the input HLS.

Used by actions: ModifyStreamLinkInput.

Name Type Description
SourceAddresses Array of DescribeHLSPullSourceAddress HLS origin server address information.

DescribeInputRISTSettings

Query the RIST configuration message of the input.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Mode String RIST mode. Options: [LISTENER|CALLER]. Default value: LISTENER.
Profile String RIST configuration solution. Options: [MAIN|SIMPLE]. Default: MAIN.
Buffer Integer RIST buffer size in milliseconds. Minimum value: 50 ms. Maximum value: 5000 ms. Default value: 120.

DescribeInputRTMPPullSettings

Query the input RTMP configuration message.

Used by actions: ModifyStreamLinkInput.

Name Type Description
SourceAddresses Array of DescribeRTMPPullSourceAddress RTMP origin server address information.

DescribeInputRTMPSettings

Query the input RTMP configuration message.

Used by actions: ModifyStreamLinkInput.

Name Type Description
AppName String RTMP push path.
StreamKey String RTMP push StreamKey.
RTMP push URL splicing rule: rtmp://Ip:1935/AppName/StreamKey

DescribeInputRTPSettings

Query the configuration message of the input RTP.

Used by actions: ModifyStreamLinkInput.

Name Type Description
FEC String Whether to enable FEC.
IdleTimeout Integer Idle timeout period.

DescribeInputRTSPPullSettings

Query the input RTSP configuration message.

Used by actions: ModifyStreamLinkInput.

Name Type Description
SourceAddresses Array of DescribeRTSPPullSourceAddress RTSP origin server address.

DescribeInputSRTSettings

Query the input SRT configuration information.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Mode String SRT mode.
StreamId String Stream Id.
Latency Integer Delay.
RecvLatency Integer Receive delay.
PeerLatency Integer Peer delay.
PeerIdleTimeout Integer Idle timeout period of the peer.
Passphrase String Decryption key.
PbKeyLen Integer Key length.
SourceAddresses Array of SRTSourceAddressResp SRT peer address.
FEC SRTFECSimpleOptions FEC settings

DescribeOutput

Configuration message for querying an output.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo.

Name Type Description
OutputId String

Output Id.
OutputName String

Output name.
OutputType String

Output type.
Description String

Output description.
Protocol String

Output protocol.
OutputAddressList Array of OutputAddress

List of output egress address information.
OutputRegion String

Output region.
SRTSettings DescribeOutputSRTSettings

SRT configuration information of the output.
RTPSettings DescribeOutputRTPSettings

Output RTP configuration message.
RTMPSettings DescribeOutputRTMPSettings

Output RTMP configuration message.
RTMPPullSettings DescribeOutputRTMPPullSettings

Output RTMP pull configuration message.
AllowIpList Array of String

CIDR allowlist.
Valid when Protocol is RTMP_PULL. If empty, it represents no limit on client IP.
RTSPPullSettings DescribeOutputRTSPPullSettings

Output RTSP pull stream configuration message.
HLSPullSettings DescribeOutputHLSPullSettings

Output HLS pull configuration message.
MaxConcurrent Integer

Maximum number of concurrent stream pulls. Maximum value: 4. Default value: 4.
SecurityGroupIds Array of String

ID of the bound security group.
Zones Array of String

Availability zone. output currently supports a maximum of one.
RISTSettings DescribeOutputRISTSettings

Output RIST configuration message.
OutputKind String

Output module type, including Pinpoint (single-point output, supports up to four concurrent outputs); MultiMesh (multiple streams output, supports more than four concurrent outputs, currently up to 200). The default type is Pinpoint output. For one Flow, only one MultiMesh output is allowed in one zone.
StreamUrls Array of StreamUrlDetail

Output module configuration, related URLs, including the provided pull stream address or the configured relay address for output to a third party
StreamSelector StreamSelector

For streams with multiple audio/video tracks, you can specify the track to be used
State String

Output status.

Enumeration values:

  • DISABLED
  • ENABLED

DescribeOutputHLSPullServerUrl

Query the output HLS pull URL information.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Url String Url of the HLS pull address.

DescribeOutputHLSPullSettings

Query the configuration message of the output HLS pull.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
ServerUrls Array of DescribeOutputHLSPullServerUrl List of HLS pull addresses.

DescribeOutputRISTSettings

Query the output RIST pull stream configuration message.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Mode String RIST mode. Valid values: LISTENER, CALLER. Default value: LISTENER.
Profile String RIST configuration solution. Options: [MAIN|SIMPLE]. Default: MAIN.
Buffer Integer RIST buffer size in milliseconds. Minimum value: 50 ms. Maximum value: 5000 ms. Default value: 120.
SourceAddresses Array of OutputRISTSourceAddressResp Server listening address, used when the RIST mode is LISTENER.

DescribeOutputRTMPPullServerUrl

Query the RTMP pull URL information in the output.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
TcUrl String tcUrl of the RTMP pull address.
StreamKey String Stream key of the RTMP pull address.

DescribeOutputRTMPPullSettings

Query the output RTMP pull stream configuration message.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
ServerUrls Array of DescribeOutputRTMPPullServerUrl List of pull addresses.

DescribeOutputRTMPSettings

Query the output RTMP configuration message.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
IdleTimeout Integer Idle timeout period.
ChunkSize Integer Chunk size.
Destinations Array of RTMPAddressDestination List of target address information for RTMP repush.

DescribeOutputRTPSettings

Query the configuration message of the output RTP.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Destinations Array of RTPAddressDestination List of target address information for RTP repush.
FEC String Whether to enable FEC.
IdleTimeout Integer Idle timeout period.

DescribeOutputRTSPPullServerUrl

Query the RTSP pull URL information in the output.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Url String RTSP pull Url.

DescribeOutputRTSPPullSettings

Query the output RTSP pull stream configuration message.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
ServerUrls Array of DescribeOutputRTSPPullServerUrl List of RTSP pull addresses.

DescribeOutputSRTSettings

Query the output SRT configuration information.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Destinations Array of SRTAddressDestination Destination address list. Used when the SRT mode is CALLER.
StreamId String Stream Id.
Latency Integer Delay.
RecvLatency Integer Receive delay.
PeerLatency Integer Peer delay.
PeerIdleTimeout Integer Idle timeout period of the peer.
Passphrase String Encryption key.
PbKeyLen Integer Encryption key length.
Mode String SRT mode.
SourceAddresses Array of OutputSRTSourceAddressResp Server listening address, used when the SRT mode is LISTENER.
FEC SRTFECFullOptions SRT FEC configuration

DescribeRTMPPullSourceAddress

Query the input RTMP configuration message.

Used by actions: ModifyStreamLinkInput.

Name Type Description
TcUrl String TcUrl of the RTMP origin server.
StreamKey String StreamKey of the RTMP origin server.
RTMP origin server URL splicing rule: $TcUrl/$StreamKey.

DescribeRTSPPullSourceAddress

Query the input RTSP configuration message.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Url String Url of the RTSP origin server.

FailOverOption

type FailOverOption struct {
FailOverType string json:"FailOverType" // Newly-added cold/standby COLDSTANDBY, HOTSTANDBY
}

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
FailOverType String No Hot backup

FlowAudio

Audio data of the stream.

Used by actions: DescribeStreamLinkFlowStatistics.

Name Type Description
Fps Integer Frame rate.
Rate Integer Bitrate in bps.
Pid Integer Audio Pid.

FlowLogInfo

Transmit streaming log information.

Used by actions: DescribeStreamLinkFlowLogs.

Name Type Description
Timestamp Integer Timestamp in seconds.
Type String Input/output type. Valid values: input, output.
InputOutputId String Input or output Id.
Protocol String Protocol.
EventCode String Event code.
EventMessage String Event information.
RemoteIp String Peer IP.
RemotePort String Peer port.
Pipeline String Primary/secondary tunnel. 0: primary, 1: backup.
InputOutputName String Input or output name.

FlowMediaAudio

Transmit audio data of streaming media.

Used by actions: DescribeStreamLinkFlowMediaStatistics.

Name Type Description
Fps Integer Frame rate.
Rate Integer Bitrate in bps.
Pid Integer Audio Pid.
SessionId String Flag of the same push.

FlowMediaInfo

Media data in the transport stream.

Used by actions: DescribeStreamLinkFlowMediaStatistics.

Name Type Description
Timestamp Integer Timestamp in seconds.
Network Integer Total bandwidth.
Video Array of FlowMediaVideo Video data of the transport stream.
Audio Array of FlowMediaAudio Audio data of the transport stream.
SessionId String Flag of the same push.
ClientIp String Client IP.

FlowMediaVideo

Transmit video data of streaming media.

Used by actions: DescribeStreamLinkFlowMediaStatistics.

Name Type Description
Fps Integer Frame rate.
Rate Integer Bitrate in bps.
Pid Integer Video Pid.
SessionId String Flag of the same push.

FlowRealtimeStatusCommon

Common status information for querying stream status in real time.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
State String Current connection status. Connected | Waiting | Idle.
Mode String Connection mode. Listener|Caller.
ConnectedTime Integer Connection duration, unit: ms.
Bitrate Integer Real-time bitrate, unit in bps.
Reconnections Integer Number of retries.

FlowRealtimeStatusItem

Stream status information of the real-time stream status query API.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
Type String Type. Valid values: Input, Output.
InputId String Input Id. If Type is Input, this field is not empty.
OutputId String Output Id. If Type is Output, this field is not empty.
FlowId String Stream Id.
Protocol String Protocol. SRT | RTMP.
CommonStatus FlowRealtimeStatusCommon Common status information.
SRTStatus FlowRealtimeStatusSRT If it is the SRT Protocol, this field will be present.
RTMPStatus FlowRealtimeStatusRTMP If it is the RTMP protocol, this field exists.
ConnectServerIP String Server IP address.
RTPStatus FlowRealtimeStatusRTP If it is the RTP protocol, this field exists.

FlowRealtimeStatusRTMP

RTMP information of the real-time stream status query API.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
VideoFPS Integer Video frame rate.
AudioFPS Integer Audio frame rate.

FlowRealtimeStatusRTP

RTP stream status information of the real-time stream status query API.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
Packets Integer Number of transmitted packets

FlowRealtimeStatusSRT

SRT information of the real-time stream status query API.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
Latency Integer Delay in ms.
RTT Integer RTT in ms.
Packets Integer Number of packets sent or received in real time.
PacketLossRate Float Packet loss rate.
RetransmitRate Float Retransmission rate.
DroppedPackets Integer Real-time packet loss count.
Encryption String Whether to encrypt. On | Off.

FlowSRTInfo

SRT quality data in the transport stream.

Used by actions: DescribeStreamLinkFlowSRTStatistics.

Name Type Description
Timestamp Integer

Timestamp in seconds.
SendPacketLossRate Integer

Packet loss rate on transmitting.
SendRetransmissionRate Integer

Retransmission rate.
RecvPacketLossRate Integer

Packet loss rate on receiving.
RecvRetransmissionRate Integer

Receiving retransmission rate.
RTT Integer

RTT latency to the peer.
SessionId String

Flag the same streaming session.
SendPacketDropNumber Integer

Number of discarded packets on sending.
RecvPacketDropNumber Integer

Number of received dropped packets.
Bandwidth Float

Bandwidth.
SendBandwidth Float

Transmit bandwidth
RecvBandwidth Float

Receiving bandwidth
SendPackets Integer

Sent packet count
RecvPackets Integer

Number of received packets
SendLostPackets Integer

Sending lost packets
RecvLostPackets Integer

Accept lost packets
SendRetransmitPackets Integer

Sent retransmission packet count
RecvRetransmitPackets Integer

Number of received retransmission packets
FlightSize Integer

Flight window size
CongestionWindow Integer

Congestion window.
SendBuffer Integer

Sending buffer (ms)
RecvBuffer Integer

Receive buffer (ms)
SendLatency Integer

Sending delay
RecvLatency Integer

Receive latency
SendNAKPackets Integer

Sent NAK packet count
RecvNAKPackets Integer

Number of received NAK packets

FlowStatistics

Stream stats.

Used by actions: DescribeStreamLinkFlowStatistics.

Name Type Description
SessionId String Session ID.
ClientIp String Peer IP.
Network Integer Total bandwidth.
Video Array of FlowVideo Video data.
Audio Array of FlowAudio Audio data.

FlowStatisticsArray

List of the stream's statistical data.

Used by actions: DescribeStreamLinkFlowStatistics.

Name Type Description
Timestamp Integer Timestamp.
FlowStatistics Array of FlowStatistics Statistics for each session.

FlowVideo

Video data of the stream.

Used by actions: DescribeStreamLinkFlowStatistics.

Name Type Description
Fps Integer Frame rate.
Rate Integer Bitrate in bps.
Pid Integer Audio Pid.

HLSPullSourceAddress

Configuration message of the created input HLS pull source station.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Url String Yes Url of the HLS origin server.

InputAddress

Input address information.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Ip String IP of the input address.
Port Integer The port of the input address.

ModifyInput

Modify the parameters of the input.

Used by actions: ModifyStreamLinkInput.

Name Type Required Description
InputId String Yes Input Id.
InputName String Yes Enter a name.
Description String Yes Input description.
AllowIpList Array of String Yes IPs allowed for push, in CIDR format.
SRTSettings CreateInputSRTSettings Yes Configuration of SRT.
RTPSettings CreateInputRTPSettings Yes Configuration message of RTP.
Protocol String No Input protocol. Options: SRT, RTP, RTMP, RTMP_PULL, RTSP_PULL, RIST.
FailOver String No Input primary/replica switch. Option: [OPEN|CLOSE].
RTMPPullSettings CreateInputRTMPPullSettings No Configuration message of RTMP_PULL.
RTSPPullSettings CreateInputRTSPPullSettings No Configuration message of RTSP_PULL.
HLSPullSettings CreateInputHLSPullSettings No Configuration message of HLS_PULL.
ResilientStream ResilientStreamConf No Configuration message for smooth stream output during delayed playback.
SecurityGroupIds Array of String No ID of the bound input security group. Only one security group can be associated.
Zones Array of String No Availability zone. Optional. input limit: two availability zones. For this API, only the second availability zone participates in resource allocation. It is valid if disaster recovery is enabled or the RTSP_PULL protocol is involved during switching. The address will be reallocated.
RISTSettings CreateInputRISTSettings No Configuration information of RIST.
InputRegion String No Region of the input node.
FailOverOption FailOverOption No Hot/cold backup related

ModifyOutputInfo

Modify the Output configuration.

Used by actions: ModifyStreamLinkOutputInfo.

Name Type Required Description
OutputId String Yes Id of the Output to be modified.
OutputName String Yes Output name.
Description String Yes Output description.
Protocol String Yes Output relay protocol. Supports SRT, RTP, RTMP, RTMP_PULL, RTSP_PULL, and RIST.
OutputType String No Output type: Internet/TencentCSS/StreamLive
OutputKind String No Output module type, including Pinpoint (single-point output, supports up to four concurrent outputs); MultiMesh (multiple outputs, supports more than four concurrent outputs, currently up to 200). The default type is Pinpoint output. For a single Flow, only one MultiMesh output is allowed in one zone.
SRTSettings CreateOutputSrtSettings No Configuration of the relayed SRT.
RTPSettings CreateOutputInfoRTPSettings No Configuration of the relayed RTP.
RTMPSettings CreateOutputRTMPSettings No Configuration for relaying RTMP.
AllowIpList Array of String No IP whitelist list in CIDR format, for example, 0.0.0.0/0.
Valid when Protocol is RTMP_PULL. If empty, it represents no limit on client IP.
MaxConcurrent Integer No Maximum number of concurrent stream pulls. Maximum value: 4. Default value: 4.
SecurityGroupIds Array of String No ID of the bound security group. Only one security group can be associated.
Zones Array of String No AZ.
RISTSettings CreateOutputRistSettings No Relay RIST configuration.
StreamSelector StreamSelector No For streams with multiple audio/video tracks, you can specify the track to be used.

OutputAddress

Egress address of the output.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Ip String Outbound IP address.

OutputRISTSourceAddressResp

Listening address for RIST output.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Ip String Listening IP.
Port Integer Listening port.

OutputSRTSourceAddressResp

SRT output listening address.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Ip String Yes Listening IP.
Port Integer Yes Listening port.

PidSelector

For streams with multiple audio/video tracks, you can specify the tracks to use.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
AudioPID Array of Integer No For streams containing multiple audio tracks, specify the audio track to use by entering a PID. The PID can be a positive integer between 1 and 8191.
VideoPID Array of Integer No For streams containing multiple video tracks, specify the video track to be used by entering a PID. You can enter a positive integer between 1 and 8191 for the PID.

RTMPAddressDestination

Target address information for RTMP repush.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Url String Destination Url for RTMP repush, in the format of 'RTMP://domain/live'.
StreamKey String Target StreamKey for RTMP republishing, in the format of 'steamid?key=value'.

RTMPPullSourceAddress

Configuration message of the created input RTMP pull source station.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
TcUrl String Yes TcUrl of the RTMP origin server.
StreamKey String Yes StreamKey information of the RTMP origin server.

RTPAddressDestination

Target address information for RTP repush.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Ip String IP of the destination address for repush.
Port Integer Port of the destination address for push.

RTSPPullSourceAddress

Configuration message of the created input RTSP pull source station.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Url String Yes Url of the RTSP origin server.

RegionInfo

Region information.

Used by actions: DescribeStreamLinkRegions.

Name Type Description
Name String Zone name.

ResilientStreamConf

Configure smooth stream output for delayed playback.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Enable Boolean No Whether to enable smooth delivery during delayed streaming. true: enable; false: disable. Not enabled by default.
BufferTime Integer No Delay time in seconds, ranging from 10 to 300 for the time being.

SRTAddressDestination

Target address information for repush.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Ip String IP of the target address.
Port Integer The port of the destination address.

SRTFECFullOptions

SRT FEC advanced configuration

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Enable Boolean No Whether to enable FEC.
Cols Integer No Number of FEC data packet Layout columns. Value range: >0
Rows Integer No Number of FEC data packet Layout rows. Value ranges from >=2 or <=-2.
ARQ String No ARQ policy when FEC is enabled. Value: "always", "onreq", "never".
Layout String No FEC data packet Layout organization. Value: "even", "staircase"

SRTFECSimpleOptions

SRT FEC settings

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Enable Boolean No Whether FEC is enabled

SRTSourceAddressReq

SRT input source address.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Ip String Yes Peer IP or domain
Port Integer Yes Peer port.

SRTSourceAddressResp

SRT input source address.

Used by actions: ModifyStreamLinkInput.

Name Type Required Description
Ip String Yes Peer IP.
Port Integer Yes Peer port.

StreamLinkRegionInfo

Region information for media transmission.

Used by actions: DescribeStreamLinkRegions.

Name Type Description
Regions Array of RegionInfo List of region information for media direct transmission.

StreamSelector

Select the specified audio track or video output

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
SelectorType String No Selection type: PID | TRACK
PidSelector PidSelector No Based on the PID configuration selector
TrackSelector TrackSelector No Select a selector based on the Track configuration

StreamUrlDetail

Description of the complete URL information

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkInput, ModifyStreamLinkOutputInfo.

Name Type Description
Label String Describes carrier information and other details.
Url String URL
Type String Playback: stream playback address;
RelayDestination: relay destination address; SourceCaptureUrl: source pull stream address; IngestEndpoint: streaming address

TrackSelector

Audio and video track selection

Used by actions: CreateStreamLinkFlow, CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
VideoIndex Array of Integer No Video track serial number. It starts from 1. Maximum value: 32.
AudioIndex Array of Integer No Video track serial number. Starts from 1. Maximum value: 32.
前の記事へ: CreateStreamLinkInput次の記事へ: Error Codes

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック

キーワードで検索
    Enter keywords to search documentation