Data Types

Last updated: 2020-12-02 11:38:21

CreateInput

Configuration information of the created input.

Used by actions: CreateMediaConnectFlow.

Name Type Required Description
InputName String Yes Input name, which can contain 1 to 32 letters, digits, and underscores.
Protocol String Yes Input protocol. Valid values: SRT, RTP.
Description String No Input description. Length: [0, 255].
AllowIpList Array of String No Allowlist of input IPs in CIDR format.
SRTSettings CreateInputSRTSettings No SRT configuration information of input.
RTPSettings CreateInputRTPSettings No RTP configuration information of input.

CreateInputRTPSettings

RTP configuration information of the created input.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, ModifyMediaConnectInput.

Name Type Required Description
FEC String No Default value: none. Valid values: ['none'].
IdleTimeout Integer No Idle timeout period in ms. Default value: 5000. Value range: [1000, 10000].

CreateInputSRTSettings

SRT configuration information of the created input.

Used by actions: CreateMediaConnectFlow, ModifyMediaConnectInput.

Name Type Required Description
StreamId String No Stream ID, which can contain 0 to 512 letters, digits, and special characters (.#!:&,=_-).
Latency Integer No Latency in ms. Default value: 0. Value range: [0, 3000].
RecvLatency Integer No Receive latency in ms. Default value: 120. Value range: [0, 3000].
PeerLatency Integer No Peer latency in ms. Default value: 0. Value range: [0, 3000].
PeerIdleTimeout Integer No Peer timeout period in ms. Default value: 5000. Value range: [1000, 10000].
Passphrase String No Decryption key, which is empty by default, indicating not to encrypt. Only ASCII codes can be filled. Length: [10, 79].
PbKeyLen Integer No Key length. Default value: 0. Valid values: 0, 16, 24, 32.

CreateOutput

Configuration information of the created output.

Used by actions: CreateMediaConnectOutput.

Name Type Required Description
OutputName String Yes Output name.
Description String Yes Output description.
Protocol String Yes Output protocol.
OutputRegion String Yes Output region.
SRTSettings CreateOutputSrtSettings No SRT configuration of output.
RTPSettings CreateInputRTPSettings No RTP configuration of output.
RTMPSettings CreateOutputRTMPSettings No RTMP configuration of output.

CreateOutputRTMPSettings

RTMP configuration of the created MediaConnect flow output.

Used by actions: CreateMediaConnectOutput, ModifyMediaConnectOutput.

Name Type Required Description
Destinations Array of CreateOutputRtmpSettingsDestinations Yes Push destination address. You can enter one or two addresses.
ChunkSize Integer No RTMP chunk size. Value range: [4096, 40960].

CreateOutputRTPSettings

RTP configuration of the created MediaConnect flow output.

Used by actions: ModifyMediaConnectOutput.

Name Type Required Description
Destinations CreateOutputRTPSettingsDestinations Yes Push destination address. You can enter one or two addresses.
FEC String Yes Only none can be entered.
IdleTimeout Integer Yes Idle timeout period.

CreateOutputRTPSettingsDestinations

RTP destination address of the created MediaConnect flow output.

Used by actions: ModifyMediaConnectOutput.

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

CreateOutputRtmpSettingsDestinations

RTMP destination address of the created MediaConnect flow output.

Used by actions: CreateMediaConnectOutput, ModifyMediaConnectOutput.

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

CreateOutputSrtSettings

SRT configuration of the created MediaConnect flow output.

Used by actions: CreateMediaConnectOutput, ModifyMediaConnectOutput.

Name Type Required Description
Destinations Array of CreateOutputSrtSettingsDestinations Yes Push destination address. Please configure one or two addresses.
StreamId String No Stream ID of SRT push.
Latency Integer No Total latency of SRT push.
RecvLatency Integer No Receive latency of SRT push.
PeerLatency Integer No Peer latency of SRT push.
PeerIdleTimeout Integer No Peer idle timeout period of SRT push.
Passphrase String No Encryption key of SRT push.
PbKeyLen Integer No Key length of SRT push.

CreateOutputSrtSettingsDestinations

SRT destination address of the created MediaConnect flow output.

Used by actions: CreateMediaConnectOutput, ModifyMediaConnectOutput.

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

DescribeFlow

Configuration information of the queried flow.

Used by actions: CreateMediaConnectFlow, DescribeMediaConnectFlow, DescribeMediaConnectFlows.

Name Type Description
FlowId String Flow ID.
FlowName String Flow name.
State String Flow status.
MaxBandwidth Integer Maximum bandwidth value.
InputGroup Array of DescribeInput Input group.
OutputGroup Array of DescribeOutput Output group.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeInput

Configuration information of the queried input.

Used by actions: CreateMediaConnectFlow, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectInput.

Name Type Description
InputId String Input ID.
InputName String Input name.
Description String Input description.
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Input protocol.
InputAddressList Array of InputAddress Input address list.
AllowIpList Array of String Input IP allowlist.
SRTSettings DescribeInputSRTSettings SRT configuration information of input.
Note: this field may return null, indicating that no valid values can be obtained.
RTPSettings DescribeInputRTPSettings RTP configuration information of input.
Note: this field may return null, indicating that no valid values can be obtained.
InputRegion String Input region.

DescribeInputRTPSettings

RTP configuration information of the queried input.

Used by actions: CreateMediaConnectFlow, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectInput.

Name Type Description
FEC String Whether it is FEC.
IdleTimeout Integer Idle timeout period.

DescribeInputSRTSettings

SRT configuration information of the queried input.

Used by actions: CreateMediaConnectFlow, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectInput.

Name Type Description
StreamId String Stream ID.
Latency Integer Latency.
RecvLatency Integer Receive latency.
PeerLatency Integer Peer latency.
PeerIdleTimeout Integer Peer idle timeout period.
Passphrase String Decryption key.
PbKeyLen Integer Key length.

DescribeOutput

Configuration information of the queried output.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectOutput.

Name Type Description
OutputId String Output ID.
OutputName String Output name.
OutputType String Output type.
Description String Output description.
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Output protocol.
OutputAddressList Array of OutputAddress Output destination address information list.
OutputRegion String Output region.
Note: this field may return null, indicating that no valid values can be obtained.
SRTSettings DescribeOutputSRTSettings SRT configuration information of output.
Note: this field may return null, indicating that no valid values can be obtained.
RTPSettings DescribeOutputRTPSettings RTP configuration information of output.
Note: this field may return null, indicating that no valid values can be obtained.
RTMPSettings DescribeOutputRTMPSettings RTMP configuration information of output.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeOutputRTMPSettings

RTMP configuration information of the queried output.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectOutput.

Name Type Description
IdleTimeout Integer Idle timeout period.
Note: this field may return null, indicating that no valid values can be obtained.
ChunkSize Integer Chunk size.
Note: this field may return null, indicating that no valid values can be obtained.
Destinations Array of RTMPAddressDestination Destination address information list of RTMP push.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeOutputRTPSettings

RTP configuration information of the queried output.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectOutput.

Name Type Description
Destinations Array of RTPAddressDestination Destination address information list of RTP push.
Note: this field may return null, indicating that no valid values can be obtained.
FEC String Whether it is FEC.
Note: this field may return null, indicating that no valid values can be obtained.
IdleTimeout Integer Idle timeout period.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeOutputSRTSettings

SRT configuration information of the queried output.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectOutput.

Name Type Description
Destinations Array of SRTAddressDestination Push destination address information list.
Note: this field may return null, indicating that no valid values can be obtained.
StreamId String Stream ID.
Note: this field may return null, indicating that no valid values can be obtained.
Latency Integer Latency.
Note: this field may return null, indicating that no valid values can be obtained.
RecvLatency Integer Receive latency.
Note: this field may return null, indicating that no valid values can be obtained.
PeerLatency Integer Peer latency.
Note: this field may return null, indicating that no valid values can be obtained.
PeerIdleTimeout Integer Peer idle timeout period.
Note: this field may return null, indicating that no valid values can be obtained.
Passphrase String Encryption key.
Note: this field may return null, indicating that no valid values can be obtained.
PbKeyLen Integer Encryption key length.
Note: this field may return null, indicating that no valid values can be obtained.

InputAddress

Input address information.

Used by actions: CreateMediaConnectFlow, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectInput.

Name Type Description
Ip String Input address IP.
Port Integer Input address port.

ModifyInput

Parameters of the modified input.

Used by actions: ModifyMediaConnectInput.

Name Type Required Description
InputId String Yes Input ID.
InputName String Yes Input name.
Description String Yes Input description.
AllowIpList Array of String Yes Allowed push IP in CIDR format.
SRTSettings CreateInputSRTSettings Yes SRT configuration information.
RTPSettings CreateInputRTPSettings Yes RTP configuration information.

ModifyOutput

Configuration of the modified output.

Used by actions: ModifyMediaConnectOutput.

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 push protocol. Valid values: SRT, RTMP.
SRTSettings CreateOutputSrtSettings No Configuration of SRT push.
RTPSettings CreateOutputRTPSettings No Configuration of RTP push.
RTMPSettings CreateOutputRTMPSettings No Configuration of RTMP push.

OutputAddress

Output destination address.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectOutput.

Name Type Description
Ip String Output destination IP.

RTMPAddressDestination

Destination address information of RTMP push.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectOutput.

Name Type Description
Url String Destination URL of RTMP push in the format of 'rtmp://domain/live'.
StreamKey String Destination StreamKey of RTMP push in the format of 'streamid?key=value'.

RTPAddressDestination

Destination address information of RTP push.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectOutput.

Name Type Description
Ip String Push destination address IP.
Port Integer Push destination address port.

SRTAddressDestination

Push destination address information.

Used by actions: CreateMediaConnectFlow, CreateMediaConnectOutput, DescribeMediaConnectFlow, DescribeMediaConnectFlows, ModifyMediaConnectOutput.

Name Type Description
Ip String Destination address IP.
Port Integer Destination address port.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help