2019/11/25 - AWS Elemental MediaLive - 12 new 15 updated api methods
Changes AWS Elemental MediaLive now supports the ability to create a multiple program transport stream (MPTS).
Gets details about a multiplex.
See also: AWS API Documentation
Request Syntax
client.describe_multiplex(
MultiplexId='string'
)
string
[REQUIRED] The ID of the multiplex.
dict
Response Syntax
{
'Arn': 'string',
'AvailabilityZones': [
'string',
],
'Destinations': [
{
'MediaConnectSettings': {
'EntitlementArn': 'string'
}
},
],
'Id': 'string',
'MultiplexSettings': {
'MaximumVideoBufferDelayMilliseconds': 123,
'TransportStreamBitrate': 123,
'TransportStreamId': 123,
'TransportStreamReservedBitrate': 123
},
'Name': 'string',
'PipelinesRunningCount': 123,
'ProgramCount': 123,
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- Details for one multiplex.
Arn (string) -- The unique arn of the multiplex.
AvailabilityZones (list) -- A list of availability zones for the multiplex.
(string) -- Placeholder documentation for __string
Destinations (list) -- A list of the multiplex output destinations.
(dict) -- Multiplex output destination settings
MediaConnectSettings (dict) -- Multiplex MediaConnect output destination settings.
EntitlementArn (string) -- The MediaConnect entitlement ARN available as a Flow source.
Id (string) -- The unique id of the multiplex.
MultiplexSettings (dict) -- Configuration for a multiplex event.
MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- Transport stream bit rate.
TransportStreamId (integer) -- Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
Name (string) -- The name of the multiplex.
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
ProgramCount (integer) -- The number of programs in the multiplex.
State (string) -- The current state of the multiplex.
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
Create a new multiplex.
See also: AWS API Documentation
Request Syntax
client.create_multiplex(
AvailabilityZones=[
'string',
],
MultiplexSettings={
'MaximumVideoBufferDelayMilliseconds': 123,
'TransportStreamBitrate': 123,
'TransportStreamId': 123,
'TransportStreamReservedBitrate': 123
},
Name='string',
RequestId='string',
Tags={
'string': 'string'
}
)
list
[REQUIRED] A list of availability zones for the multiplex. You must specify exactly two.
(string) -- Placeholder documentation for __string
dict
[REQUIRED] Configuration for a multiplex event.
MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- [REQUIRED] Transport stream bit rate.
TransportStreamId (integer) -- [REQUIRED] Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
string
[REQUIRED] Name of multiplex.
string
[REQUIRED] Unique request ID. This prevents retries from creating multiple resources. This field is autopopulated if not provided.
dict
A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
dict
Response Syntax
{
'Multiplex': {
'Arn': 'string',
'AvailabilityZones': [
'string',
],
'Destinations': [
{
'MediaConnectSettings': {
'EntitlementArn': 'string'
}
},
],
'Id': 'string',
'MultiplexSettings': {
'MaximumVideoBufferDelayMilliseconds': 123,
'TransportStreamBitrate': 123,
'TransportStreamId': 123,
'TransportStreamReservedBitrate': 123
},
'Name': 'string',
'PipelinesRunningCount': 123,
'ProgramCount': 123,
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) -- Creation of the multiplex is in progress.
Multiplex (dict) -- The newly created multiplex.
Arn (string) -- The unique arn of the multiplex.
AvailabilityZones (list) -- A list of availability zones for the multiplex.
(string) -- Placeholder documentation for __string
Destinations (list) -- A list of the multiplex output destinations.
(dict) -- Multiplex output destination settings
MediaConnectSettings (dict) -- Multiplex MediaConnect output destination settings.
EntitlementArn (string) -- The MediaConnect entitlement ARN available as a Flow source.
Id (string) -- The unique id of the multiplex.
MultiplexSettings (dict) -- Configuration for a multiplex event.
MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- Transport stream bit rate.
TransportStreamId (integer) -- Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
Name (string) -- The name of the multiplex.
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
ProgramCount (integer) -- The number of programs in the multiplex.
State (string) -- The current state of the multiplex.
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
Retrieve a list of the existing multiplexes.
See also: AWS API Documentation
Request Syntax
client.list_multiplexes(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of items to return.
string
The token to retrieve the next page of results.
dict
Response Syntax
{
'Multiplexes': [
{
'Arn': 'string',
'AvailabilityZones': [
'string',
],
'Id': 'string',
'MultiplexSettings': {
'TransportStreamBitrate': 123
},
'Name': 'string',
'PipelinesRunningCount': 123,
'ProgramCount': 123,
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- An array of multiplexes.
Multiplexes (list) -- List of multiplexes.
(dict) -- Placeholder documentation for MultiplexSummary
Arn (string) -- The unique arn of the multiplex.
AvailabilityZones (list) -- A list of availability zones for the multiplex.
(string) -- Placeholder documentation for __string
Id (string) -- The unique id of the multiplex.
MultiplexSettings (dict) -- Configuration for a multiplex event.
TransportStreamBitrate (integer) -- Transport stream bit rate.
Name (string) -- The name of the multiplex.
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
ProgramCount (integer) -- The number of programs in the multiplex.
State (string) -- The current state of the multiplex.
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
NextToken (string) -- Token for the next ListMultiplexes request.
Updates a multiplex.
See also: AWS API Documentation
Request Syntax
client.update_multiplex(
MultiplexId='string',
MultiplexSettings={
'MaximumVideoBufferDelayMilliseconds': 123,
'TransportStreamBitrate': 123,
'TransportStreamId': 123,
'TransportStreamReservedBitrate': 123
},
Name='string'
)
string
[REQUIRED] ID of the multiplex to update.
dict
The new settings for a multiplex.
MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- [REQUIRED] Transport stream bit rate.
TransportStreamId (integer) -- [REQUIRED] Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
string
Name of the multiplex.
dict
Response Syntax
{
'Multiplex': {
'Arn': 'string',
'AvailabilityZones': [
'string',
],
'Destinations': [
{
'MediaConnectSettings': {
'EntitlementArn': 'string'
}
},
],
'Id': 'string',
'MultiplexSettings': {
'MaximumVideoBufferDelayMilliseconds': 123,
'TransportStreamBitrate': 123,
'TransportStreamId': 123,
'TransportStreamReservedBitrate': 123
},
'Name': 'string',
'PipelinesRunningCount': 123,
'ProgramCount': 123,
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) -- The update to the multiplex has succeeded.
Multiplex (dict) -- The updated multiplex.
Arn (string) -- The unique arn of the multiplex.
AvailabilityZones (list) -- A list of availability zones for the multiplex.
(string) -- Placeholder documentation for __string
Destinations (list) -- A list of the multiplex output destinations.
(dict) -- Multiplex output destination settings
MediaConnectSettings (dict) -- Multiplex MediaConnect output destination settings.
EntitlementArn (string) -- The MediaConnect entitlement ARN available as a Flow source.
Id (string) -- The unique id of the multiplex.
MultiplexSettings (dict) -- Configuration for a multiplex event.
MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- Transport stream bit rate.
TransportStreamId (integer) -- Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
Name (string) -- The name of the multiplex.
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
ProgramCount (integer) -- The number of programs in the multiplex.
State (string) -- The current state of the multiplex.
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
Create a new program in the multiplex.
See also: AWS API Documentation
Request Syntax
client.create_multiplex_program(
MultiplexId='string',
MultiplexProgramSettings={
'ProgramNumber': 123,
'ServiceDescriptor': {
'ProviderName': 'string',
'ServiceName': 'string'
},
'VideoSettings': {
'ConstantBitrate': 123,
'StatmuxSettings': {
'MaximumBitrate': 123,
'MinimumBitrate': 123
}
}
},
ProgramName='string',
RequestId='string'
)
string
[REQUIRED] ID of the multiplex where the program is to be created.
dict
[REQUIRED] The settings for this multiplex program.
ProgramNumber (integer) -- [REQUIRED] Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
ProviderName (string) -- [REQUIRED] Name of the provider.
ServiceName (string) -- [REQUIRED] Name of the service.
VideoSettings (dict) -- Program video settings configuration.
ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
MaximumBitrate (integer) -- Maximum statmux bitrate.
MinimumBitrate (integer) -- Minimum statmux bitrate.
string
[REQUIRED] Name of multiplex program.
string
[REQUIRED] Unique request ID. This prevents retries from creating multiple resources. This field is autopopulated if not provided.
dict
Response Syntax
{
'MultiplexProgram': {
'ChannelId': 'string',
'MultiplexProgramSettings': {
'ProgramNumber': 123,
'ServiceDescriptor': {
'ProviderName': 'string',
'ServiceName': 'string'
},
'VideoSettings': {
'ConstantBitrate': 123,
'StatmuxSettings': {
'MaximumBitrate': 123,
'MinimumBitrate': 123
}
}
},
'PacketIdentifiersMap': {
'AudioPids': [
123,
],
'DvbSubPids': [
123,
],
'DvbTeletextPid': 123,
'EtvPlatformPid': 123,
'EtvSignalPid': 123,
'KlvDataPids': [
123,
],
'PcrPid': 123,
'PmtPid': 123,
'PrivateMetadataPid': 123,
'Scte27Pids': [
123,
],
'Scte35Pid': 123,
'TimedMetadataPid': 123,
'VideoPid': 123
},
'ProgramName': 'string'
}
}
Response Structure
(dict) -- Creation of the program is in progress.
MultiplexProgram (dict) -- The newly created multiplex program.
ChannelId (string) -- The MediaLive channel associated with the program.
MultiplexProgramSettings (dict) -- The settings for this multiplex program.
ProgramNumber (integer) -- Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
ProviderName (string) -- Name of the provider.
ServiceName (string) -- Name of the service.
VideoSettings (dict) -- Program video settings configuration.
ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
MaximumBitrate (integer) -- Maximum statmux bitrate.
MinimumBitrate (integer) -- Minimum statmux bitrate.
PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
AudioPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
DvbSubPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
DvbTeletextPid (integer) -- Placeholder documentation for __integer
EtvPlatformPid (integer) -- Placeholder documentation for __integer
EtvSignalPid (integer) -- Placeholder documentation for __integer
KlvDataPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
PcrPid (integer) -- Placeholder documentation for __integer
PmtPid (integer) -- Placeholder documentation for __integer
PrivateMetadataPid (integer) -- Placeholder documentation for __integer
Scte27Pids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
Scte35Pid (integer) -- Placeholder documentation for __integer
TimedMetadataPid (integer) -- Placeholder documentation for __integer
VideoPid (integer) -- Placeholder documentation for __integer
ProgramName (string) -- The name of the multiplex program.
Delete a multiplex. The multiplex must be idle.
See also: AWS API Documentation
Request Syntax
client.delete_multiplex(
MultiplexId='string'
)
string
[REQUIRED] The ID of the multiplex.
dict
Response Syntax
{
'Arn': 'string',
'AvailabilityZones': [
'string',
],
'Destinations': [
{
'MediaConnectSettings': {
'EntitlementArn': 'string'
}
},
],
'Id': 'string',
'MultiplexSettings': {
'MaximumVideoBufferDelayMilliseconds': 123,
'TransportStreamBitrate': 123,
'TransportStreamId': 123,
'TransportStreamReservedBitrate': 123
},
'Name': 'string',
'PipelinesRunningCount': 123,
'ProgramCount': 123,
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- Deletion of the multiplex is in progress.
Arn (string) -- The unique arn of the multiplex.
AvailabilityZones (list) -- A list of availability zones for the multiplex.
(string) -- Placeholder documentation for __string
Destinations (list) -- A list of the multiplex output destinations.
(dict) -- Multiplex output destination settings
MediaConnectSettings (dict) -- Multiplex MediaConnect output destination settings.
EntitlementArn (string) -- The MediaConnect entitlement ARN available as a Flow source.
Id (string) -- The unique id of the multiplex.
MultiplexSettings (dict) -- Configuration for a multiplex event.
MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- Transport stream bit rate.
TransportStreamId (integer) -- Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
Name (string) -- The name of the multiplex.
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
ProgramCount (integer) -- The number of programs in the multiplex.
State (string) -- The current state of the multiplex.
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
Delete a program from a multiplex.
See also: AWS API Documentation
Request Syntax
client.delete_multiplex_program(
MultiplexId='string',
ProgramName='string'
)
string
[REQUIRED] The ID of the multiplex that the program belongs to.
string
[REQUIRED] The multiplex program name.
dict
Response Syntax
{
'ChannelId': 'string',
'MultiplexProgramSettings': {
'ProgramNumber': 123,
'ServiceDescriptor': {
'ProviderName': 'string',
'ServiceName': 'string'
},
'VideoSettings': {
'ConstantBitrate': 123,
'StatmuxSettings': {
'MaximumBitrate': 123,
'MinimumBitrate': 123
}
}
},
'PacketIdentifiersMap': {
'AudioPids': [
123,
],
'DvbSubPids': [
123,
],
'DvbTeletextPid': 123,
'EtvPlatformPid': 123,
'EtvSignalPid': 123,
'KlvDataPids': [
123,
],
'PcrPid': 123,
'PmtPid': 123,
'PrivateMetadataPid': 123,
'Scte27Pids': [
123,
],
'Scte35Pid': 123,
'TimedMetadataPid': 123,
'VideoPid': 123
},
'ProgramName': 'string'
}
Response Structure
(dict) -- Deletion of the program is in progress.
ChannelId (string) -- The MediaLive channel associated with the program.
MultiplexProgramSettings (dict) -- The settings for this multiplex program.
ProgramNumber (integer) -- Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
ProviderName (string) -- Name of the provider.
ServiceName (string) -- Name of the service.
VideoSettings (dict) -- Program video settings configuration.
ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
MaximumBitrate (integer) -- Maximum statmux bitrate.
MinimumBitrate (integer) -- Minimum statmux bitrate.
PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
AudioPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
DvbSubPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
DvbTeletextPid (integer) -- Placeholder documentation for __integer
EtvPlatformPid (integer) -- Placeholder documentation for __integer
EtvSignalPid (integer) -- Placeholder documentation for __integer
KlvDataPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
PcrPid (integer) -- Placeholder documentation for __integer
PmtPid (integer) -- Placeholder documentation for __integer
PrivateMetadataPid (integer) -- Placeholder documentation for __integer
Scte27Pids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
Scte35Pid (integer) -- Placeholder documentation for __integer
TimedMetadataPid (integer) -- Placeholder documentation for __integer
VideoPid (integer) -- Placeholder documentation for __integer
ProgramName (string) -- The name of the multiplex program.
Stops a running multiplex. If the multiplex isn't running, this action has no effect.
See also: AWS API Documentation
Request Syntax
client.stop_multiplex(
MultiplexId='string'
)
string
[REQUIRED] The ID of the multiplex.
dict
Response Syntax
{
'Arn': 'string',
'AvailabilityZones': [
'string',
],
'Destinations': [
{
'MediaConnectSettings': {
'EntitlementArn': 'string'
}
},
],
'Id': 'string',
'MultiplexSettings': {
'MaximumVideoBufferDelayMilliseconds': 123,
'TransportStreamBitrate': 123,
'TransportStreamId': 123,
'TransportStreamReservedBitrate': 123
},
'Name': 'string',
'PipelinesRunningCount': 123,
'ProgramCount': 123,
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- The action to stop the multiplex is in progress.
Arn (string) -- The unique arn of the multiplex.
AvailabilityZones (list) -- A list of availability zones for the multiplex.
(string) -- Placeholder documentation for __string
Destinations (list) -- A list of the multiplex output destinations.
(dict) -- Multiplex output destination settings
MediaConnectSettings (dict) -- Multiplex MediaConnect output destination settings.
EntitlementArn (string) -- The MediaConnect entitlement ARN available as a Flow source.
Id (string) -- The unique id of the multiplex.
MultiplexSettings (dict) -- Configuration for a multiplex event.
MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- Transport stream bit rate.
TransportStreamId (integer) -- Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
Name (string) -- The name of the multiplex.
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
ProgramCount (integer) -- The number of programs in the multiplex.
State (string) -- The current state of the multiplex.
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
Update a program in a multiplex.
See also: AWS API Documentation
Request Syntax
client.update_multiplex_program(
MultiplexId='string',
MultiplexProgramSettings={
'ProgramNumber': 123,
'ServiceDescriptor': {
'ProviderName': 'string',
'ServiceName': 'string'
},
'VideoSettings': {
'ConstantBitrate': 123,
'StatmuxSettings': {
'MaximumBitrate': 123,
'MinimumBitrate': 123
}
}
},
ProgramName='string'
)
string
[REQUIRED] The ID of the multiplex of the program to update.
dict
The new settings for a multiplex program.
ProgramNumber (integer) -- [REQUIRED] Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
ProviderName (string) -- [REQUIRED] Name of the provider.
ServiceName (string) -- [REQUIRED] Name of the service.
VideoSettings (dict) -- Program video settings configuration.
ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
MaximumBitrate (integer) -- Maximum statmux bitrate.
MinimumBitrate (integer) -- Minimum statmux bitrate.
string
[REQUIRED] The name of the program to update.
dict
Response Syntax
{
'MultiplexProgram': {
'ChannelId': 'string',
'MultiplexProgramSettings': {
'ProgramNumber': 123,
'ServiceDescriptor': {
'ProviderName': 'string',
'ServiceName': 'string'
},
'VideoSettings': {
'ConstantBitrate': 123,
'StatmuxSettings': {
'MaximumBitrate': 123,
'MinimumBitrate': 123
}
}
},
'PacketIdentifiersMap': {
'AudioPids': [
123,
],
'DvbSubPids': [
123,
],
'DvbTeletextPid': 123,
'EtvPlatformPid': 123,
'EtvSignalPid': 123,
'KlvDataPids': [
123,
],
'PcrPid': 123,
'PmtPid': 123,
'PrivateMetadataPid': 123,
'Scte27Pids': [
123,
],
'Scte35Pid': 123,
'TimedMetadataPid': 123,
'VideoPid': 123
},
'ProgramName': 'string'
}
}
Response Structure
(dict) -- The update to the program has succeeded.
MultiplexProgram (dict) -- The updated multiplex program.
ChannelId (string) -- The MediaLive channel associated with the program.
MultiplexProgramSettings (dict) -- The settings for this multiplex program.
ProgramNumber (integer) -- Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
ProviderName (string) -- Name of the provider.
ServiceName (string) -- Name of the service.
VideoSettings (dict) -- Program video settings configuration.
ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
MaximumBitrate (integer) -- Maximum statmux bitrate.
MinimumBitrate (integer) -- Minimum statmux bitrate.
PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
AudioPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
DvbSubPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
DvbTeletextPid (integer) -- Placeholder documentation for __integer
EtvPlatformPid (integer) -- Placeholder documentation for __integer
EtvSignalPid (integer) -- Placeholder documentation for __integer
KlvDataPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
PcrPid (integer) -- Placeholder documentation for __integer
PmtPid (integer) -- Placeholder documentation for __integer
PrivateMetadataPid (integer) -- Placeholder documentation for __integer
Scte27Pids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
Scte35Pid (integer) -- Placeholder documentation for __integer
TimedMetadataPid (integer) -- Placeholder documentation for __integer
VideoPid (integer) -- Placeholder documentation for __integer
ProgramName (string) -- The name of the multiplex program.
Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.
See also: AWS API Documentation
Request Syntax
client.start_multiplex(
MultiplexId='string'
)
string
[REQUIRED] The ID of the multiplex.
dict
Response Syntax
{
'Arn': 'string',
'AvailabilityZones': [
'string',
],
'Destinations': [
{
'MediaConnectSettings': {
'EntitlementArn': 'string'
}
},
],
'Id': 'string',
'MultiplexSettings': {
'MaximumVideoBufferDelayMilliseconds': 123,
'TransportStreamBitrate': 123,
'TransportStreamId': 123,
'TransportStreamReservedBitrate': 123
},
'Name': 'string',
'PipelinesRunningCount': 123,
'ProgramCount': 123,
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- The action to start the multiplex is in progress.
Arn (string) -- The unique arn of the multiplex.
AvailabilityZones (list) -- A list of availability zones for the multiplex.
(string) -- Placeholder documentation for __string
Destinations (list) -- A list of the multiplex output destinations.
(dict) -- Multiplex output destination settings
MediaConnectSettings (dict) -- Multiplex MediaConnect output destination settings.
EntitlementArn (string) -- The MediaConnect entitlement ARN available as a Flow source.
Id (string) -- The unique id of the multiplex.
MultiplexSettings (dict) -- Configuration for a multiplex event.
MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- Transport stream bit rate.
TransportStreamId (integer) -- Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
Name (string) -- The name of the multiplex.
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
ProgramCount (integer) -- The number of programs in the multiplex.
State (string) -- The current state of the multiplex.
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
Get the details for a program in a multiplex.
See also: AWS API Documentation
Request Syntax
client.describe_multiplex_program(
MultiplexId='string',
ProgramName='string'
)
string
[REQUIRED] The ID of the multiplex that the program belongs to.
string
[REQUIRED] The name of the program.
dict
Response Syntax
{
'ChannelId': 'string',
'MultiplexProgramSettings': {
'ProgramNumber': 123,
'ServiceDescriptor': {
'ProviderName': 'string',
'ServiceName': 'string'
},
'VideoSettings': {
'ConstantBitrate': 123,
'StatmuxSettings': {
'MaximumBitrate': 123,
'MinimumBitrate': 123
}
}
},
'PacketIdentifiersMap': {
'AudioPids': [
123,
],
'DvbSubPids': [
123,
],
'DvbTeletextPid': 123,
'EtvPlatformPid': 123,
'EtvSignalPid': 123,
'KlvDataPids': [
123,
],
'PcrPid': 123,
'PmtPid': 123,
'PrivateMetadataPid': 123,
'Scte27Pids': [
123,
],
'Scte35Pid': 123,
'TimedMetadataPid': 123,
'VideoPid': 123
},
'ProgramName': 'string'
}
Response Structure
(dict) -- The details of one program.
ChannelId (string) -- The MediaLive channel associated with the program.
MultiplexProgramSettings (dict) -- The settings for this multiplex program.
ProgramNumber (integer) -- Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
ProviderName (string) -- Name of the provider.
ServiceName (string) -- Name of the service.
VideoSettings (dict) -- Program video settings configuration.
ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
MaximumBitrate (integer) -- Maximum statmux bitrate.
MinimumBitrate (integer) -- Minimum statmux bitrate.
PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
AudioPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
DvbSubPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
DvbTeletextPid (integer) -- Placeholder documentation for __integer
EtvPlatformPid (integer) -- Placeholder documentation for __integer
EtvSignalPid (integer) -- Placeholder documentation for __integer
KlvDataPids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
PcrPid (integer) -- Placeholder documentation for __integer
PmtPid (integer) -- Placeholder documentation for __integer
PrivateMetadataPid (integer) -- Placeholder documentation for __integer
Scte27Pids (list) -- Placeholder documentation for __listOf__integer
(integer) -- Placeholder documentation for __integer
Scte35Pid (integer) -- Placeholder documentation for __integer
TimedMetadataPid (integer) -- Placeholder documentation for __integer
VideoPid (integer) -- Placeholder documentation for __integer
ProgramName (string) -- The name of the multiplex program.
List the programs that currently exist for a specific multiplex.
See also: AWS API Documentation
Request Syntax
client.list_multiplex_programs(
MaxResults=123,
MultiplexId='string',
NextToken='string'
)
integer
The maximum number of items to return.
string
[REQUIRED] The ID of the multiplex that the programs belong to.
string
The token to retrieve the next page of results.
dict
Response Syntax
{
'MultiplexPrograms': [
{
'ChannelId': 'string',
'ProgramName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- An array of the programs for one multiplex.
MultiplexPrograms (list) -- List of multiplex programs.
(dict) -- Placeholder documentation for MultiplexProgramSummary
ChannelId (string) -- The MediaLive Channel associated with the program.
ProgramName (string) -- The name of the multiplex program.
NextToken (string) -- Token for the next ListMultiplexProgram request.
{'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}
Response {'Channel': {'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}}
Creates a new channel
See also: AWS API Documentation
Request Syntax
client.create_channel(
ChannelClass='STANDARD'|'SINGLE_PIPELINE',
Destinations=[
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
EncoderSettings={
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {}
,
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {}
,
'EmbeddedPlusScte20DestinationSettings': {}
,
'RtmpCaptionInfoDestinationSettings': {}
,
'Scte20PlusEmbeddedDestinationSettings': {}
,
'Scte27DestinationSettings': {}
,
'SmpteTtDestinationSettings': {}
,
'TeletextDestinationSettings': {}
,
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {}
,
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {}
,
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {}
,
'Rec601Settings': {}
,
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {}
,
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {}
,
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
InputAttachments=[
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {}
,
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
InputSpecification={
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
LogLevel='ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
Name='string',
RequestId='string',
Reserved='string',
RoleArn='string',
Tags={
'string': 'string'
}
)
string
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
list
Placeholder documentation for __listOfOutputDestination
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
dict
Encoder Settings
AudioDescriptions (list) -- [REQUIRED] Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- [REQUIRED] The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- [REQUIRED] The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- [REQUIRED] Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- [REQUIRED] Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- [REQUIRED] Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- [REQUIRED] The index of the input channel used as a source.
OutputChannel (integer) -- [REQUIRED] The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- [REQUIRED] Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- [REQUIRED] Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- [REQUIRED] Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- [REQUIRED] Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- [REQUIRED] A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- [REQUIRED] The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- [REQUIRED] The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- [REQUIRED] Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- [REQUIRED] Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- [REQUIRED] A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- [REQUIRED] Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- [REQUIRED] MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- [REQUIRED] Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- [REQUIRED] Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- [REQUIRED] Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- [REQUIRED] Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- [REQUIRED] The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- [REQUIRED] The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- [REQUIRED] Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- [REQUIRED] Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- [REQUIRED] Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- [REQUIRED] The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- [REQUIRED] Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- [REQUIRED] The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- [REQUIRED] The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- [REQUIRED] Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- [REQUIRED] Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- [REQUIRED] Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- [REQUIRED] Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- [REQUIRED] The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- [REQUIRED] Framerate denominator.
FramerateNumerator (integer) -- [REQUIRED] Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- [REQUIRED] The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
list
List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- [REQUIRED] The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- [REQUIRED] Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- [REQUIRED] Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- [REQUIRED] Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
dict
Specification of input for this channel (max. bitrate, resolution, codec, etc.)
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
string
The log level to write to CloudWatch Logs.
string
Name of channel.
string
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources. This field is autopopulated if not provided.
string
Deprecated field that's only usable by whitelisted customers.
string
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.
dict
A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
dict
Response Syntax
{
'Channel': {
'Arn': 'string',
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Destinations': [
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
'EgressEndpoints': [
{
'SourceIp': 'string'
},
],
'EncoderSettings': {
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {},
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {},
'EmbeddedPlusScte20DestinationSettings': {},
'RtmpCaptionInfoDestinationSettings': {},
'Scte20PlusEmbeddedDestinationSettings': {},
'Scte27DestinationSettings': {},
'SmpteTtDestinationSettings': {},
'TeletextDestinationSettings': {},
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {},
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {},
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Rec601Settings': {},
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {},
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
'Id': 'string',
'InputAttachments': [
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {},
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
'InputSpecification': {
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
'LogLevel': 'ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
'Name': 'string',
'PipelineDetails': [
{
'ActiveInputAttachmentName': 'string',
'ActiveInputSwitchActionName': 'string',
'PipelineId': 'string'
},
],
'PipelinesRunningCount': 123,
'RoleArn': 'string',
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED'|'UPDATING'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) -- Creation of channel is started.
Channel (dict) -- Placeholder documentation for Channel
Arn (string) -- The unique arn of the channel.
ChannelClass (string) -- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Destinations (list) -- A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
EgressEndpoints (list) -- The endpoints where outgoing connections initiate from
(dict) -- Placeholder documentation for ChannelEgressEndpoint
SourceIp (string) -- Public IP of where a channel's output comes from
EncoderSettings (dict) -- Encoder Settings
AudioDescriptions (list) -- Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- The index of the input channel used as a source.
OutputChannel (integer) -- The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Id (string) -- The unique id of the channel.
InputAttachments (list) -- List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
InputSpecification (dict) -- Placeholder documentation for InputSpecification
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
LogLevel (string) -- The log level being written to CloudWatch Logs.
Name (string) -- The name of the channel. (user-mutable)
PipelineDetails (list) -- Runtime details for the pipelines of a running channel.
(dict) -- Runtime details of a pipeline when a channel is running.
ActiveInputAttachmentName (string) -- The name of the active input attachment currently being ingested by this pipeline.
ActiveInputSwitchActionName (string) -- The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
PipelineId (string) -- Pipeline ID
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
RoleArn (string) -- The Amazon Resource Name (ARN) of the role assumed when running the Channel.
State (string) -- Placeholder documentation for ChannelState
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
{'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}
Starts deletion of channel. The associated outputs are also deleted.
See also: AWS API Documentation
Request Syntax
client.delete_channel(
ChannelId='string'
)
string
[REQUIRED] Unique ID of the channel.
dict
Response Syntax
{
'Arn': 'string',
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Destinations': [
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
'EgressEndpoints': [
{
'SourceIp': 'string'
},
],
'EncoderSettings': {
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {},
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {},
'EmbeddedPlusScte20DestinationSettings': {},
'RtmpCaptionInfoDestinationSettings': {},
'Scte20PlusEmbeddedDestinationSettings': {},
'Scte27DestinationSettings': {},
'SmpteTtDestinationSettings': {},
'TeletextDestinationSettings': {},
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {},
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {},
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Rec601Settings': {},
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {},
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
'Id': 'string',
'InputAttachments': [
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {},
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
'InputSpecification': {
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
'LogLevel': 'ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
'Name': 'string',
'PipelineDetails': [
{
'ActiveInputAttachmentName': 'string',
'ActiveInputSwitchActionName': 'string',
'PipelineId': 'string'
},
],
'PipelinesRunningCount': 123,
'RoleArn': 'string',
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED'|'UPDATING'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- Deletion was successfully initiated.
Arn (string) -- The unique arn of the channel.
ChannelClass (string) -- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Destinations (list) -- A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
EgressEndpoints (list) -- The endpoints where outgoing connections initiate from
(dict) -- Placeholder documentation for ChannelEgressEndpoint
SourceIp (string) -- Public IP of where a channel's output comes from
EncoderSettings (dict) -- Encoder Settings
AudioDescriptions (list) -- Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- The index of the input channel used as a source.
OutputChannel (integer) -- The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Id (string) -- The unique id of the channel.
InputAttachments (list) -- List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
InputSpecification (dict) -- Placeholder documentation for InputSpecification
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
LogLevel (string) -- The log level being written to CloudWatch Logs.
Name (string) -- The name of the channel. (user-mutable)
PipelineDetails (list) -- Runtime details for the pipelines of a running channel.
(dict) -- Runtime details of a pipeline when a channel is running.
ActiveInputAttachmentName (string) -- The name of the active input attachment currently being ingested by this pipeline.
ActiveInputSwitchActionName (string) -- The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
PipelineId (string) -- Pipeline ID
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
RoleArn (string) -- The Amazon Resource Name (ARN) of the role assumed when running the Channel.
State (string) -- Placeholder documentation for ChannelState
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
{'ResourceSpecification': {'Resolution': ['FHD'],
'ResourceType': ['MULTIPLEX']}}
Delete an expired reservation.
See also: AWS API Documentation
Request Syntax
client.delete_reservation(
ReservationId='string'
)
string
[REQUIRED] Unique reservation ID, e.g. '1234567'
dict
Response Syntax
{
'Arn': 'string',
'Count': 123,
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'FixedPrice': 123.0,
'Name': 'string',
'OfferingDescription': 'string',
'OfferingId': 'string',
'OfferingType': 'NO_UPFRONT',
'Region': 'string',
'ReservationId': 'string',
'ResourceSpecification': {
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
'Resolution': 'SD'|'HD'|'FHD'|'UHD',
'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
},
'Start': 'string',
'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
'Tags': {
'string': 'string'
},
'UsagePrice': 123.0
}
Response Structure
(dict) -- Deleted reservation
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
Duration (integer) -- Lease duration, e.g. '12'
DurationUnits (string) -- Units for duration, e.g. 'MONTHS'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
OfferingId (string) -- Unique offering ID, e.g. '87654321'
OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'
Region (string) -- AWS region, e.g. 'us-west-2'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
ChannelClass (string) -- Channel class, e.g. 'STANDARD'
Codec (string) -- Codec, e.g. 'AVC'
MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'
MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
Resolution (string) -- Resolution, e.g. 'HD'
ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
Tags (dict) -- A collection of key-value pairs
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
{'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}
Gets details about a channel
See also: AWS API Documentation
Request Syntax
client.describe_channel(
ChannelId='string'
)
string
[REQUIRED] channel ID
dict
Response Syntax
{
'Arn': 'string',
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Destinations': [
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
'EgressEndpoints': [
{
'SourceIp': 'string'
},
],
'EncoderSettings': {
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {},
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {},
'EmbeddedPlusScte20DestinationSettings': {},
'RtmpCaptionInfoDestinationSettings': {},
'Scte20PlusEmbeddedDestinationSettings': {},
'Scte27DestinationSettings': {},
'SmpteTtDestinationSettings': {},
'TeletextDestinationSettings': {},
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {},
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {},
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Rec601Settings': {},
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {},
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
'Id': 'string',
'InputAttachments': [
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {},
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
'InputSpecification': {
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
'LogLevel': 'ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
'Name': 'string',
'PipelineDetails': [
{
'ActiveInputAttachmentName': 'string',
'ActiveInputSwitchActionName': 'string',
'PipelineId': 'string'
},
],
'PipelinesRunningCount': 123,
'RoleArn': 'string',
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED'|'UPDATING'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- Channel details
Arn (string) -- The unique arn of the channel.
ChannelClass (string) -- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Destinations (list) -- A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
EgressEndpoints (list) -- The endpoints where outgoing connections initiate from
(dict) -- Placeholder documentation for ChannelEgressEndpoint
SourceIp (string) -- Public IP of where a channel's output comes from
EncoderSettings (dict) -- Encoder Settings
AudioDescriptions (list) -- Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- The index of the input channel used as a source.
OutputChannel (integer) -- The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Id (string) -- The unique id of the channel.
InputAttachments (list) -- List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
InputSpecification (dict) -- Placeholder documentation for InputSpecification
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
LogLevel (string) -- The log level being written to CloudWatch Logs.
Name (string) -- The name of the channel. (user-mutable)
PipelineDetails (list) -- Runtime details for the pipelines of a running channel.
(dict) -- Runtime details of a pipeline when a channel is running.
ActiveInputAttachmentName (string) -- The name of the active input attachment currently being ingested by this pipeline.
ActiveInputSwitchActionName (string) -- The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
PipelineId (string) -- Pipeline ID
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
RoleArn (string) -- The Amazon Resource Name (ARN) of the role assumed when running the Channel.
State (string) -- Placeholder documentation for ChannelState
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
{'ResourceSpecification': {'Resolution': ['FHD'],
'ResourceType': ['MULTIPLEX']}}
Get details for an offering.
See also: AWS API Documentation
Request Syntax
client.describe_offering(
OfferingId='string'
)
string
[REQUIRED] Unique offering ID, e.g. '87654321'
dict
Response Syntax
{
'Arn': 'string',
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'FixedPrice': 123.0,
'OfferingDescription': 'string',
'OfferingId': 'string',
'OfferingType': 'NO_UPFRONT',
'Region': 'string',
'ResourceSpecification': {
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
'Resolution': 'SD'|'HD'|'FHD'|'UHD',
'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
},
'UsagePrice': 123.0
}
Response Structure
(dict) -- Offering details
Arn (string) -- Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'
CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
Duration (integer) -- Lease duration, e.g. '12'
DurationUnits (string) -- Units for duration, e.g. 'MONTHS'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
OfferingId (string) -- Unique offering ID, e.g. '87654321'
OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'
Region (string) -- AWS region, e.g. 'us-west-2'
ResourceSpecification (dict) -- Resource configuration details
ChannelClass (string) -- Channel class, e.g. 'STANDARD'
Codec (string) -- Codec, e.g. 'AVC'
MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'
MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
Resolution (string) -- Resolution, e.g. 'HD'
ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
{'ResourceSpecification': {'Resolution': ['FHD'],
'ResourceType': ['MULTIPLEX']}}
Get details for a reservation.
See also: AWS API Documentation
Request Syntax
client.describe_reservation(
ReservationId='string'
)
string
[REQUIRED] Unique reservation ID, e.g. '1234567'
dict
Response Syntax
{
'Arn': 'string',
'Count': 123,
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'FixedPrice': 123.0,
'Name': 'string',
'OfferingDescription': 'string',
'OfferingId': 'string',
'OfferingType': 'NO_UPFRONT',
'Region': 'string',
'ReservationId': 'string',
'ResourceSpecification': {
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
'Resolution': 'SD'|'HD'|'FHD'|'UHD',
'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
},
'Start': 'string',
'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
'Tags': {
'string': 'string'
},
'UsagePrice': 123.0
}
Response Structure
(dict) -- Reservation details
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
Duration (integer) -- Lease duration, e.g. '12'
DurationUnits (string) -- Units for duration, e.g. 'MONTHS'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
OfferingId (string) -- Unique offering ID, e.g. '87654321'
OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'
Region (string) -- AWS region, e.g. 'us-west-2'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
ChannelClass (string) -- Channel class, e.g. 'STANDARD'
Codec (string) -- Codec, e.g. 'AVC'
MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'
MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
Resolution (string) -- Resolution, e.g. 'HD'
ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
Tags (dict) -- A collection of key-value pairs
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
{'Channels': {'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}}}}
Produces list of channels that have been created
See also: AWS API Documentation
Request Syntax
client.list_channels(
MaxResults=123,
NextToken='string'
)
integer
Placeholder documentation for MaxResults
string
Placeholder documentation for __string
dict
Response Syntax
{
'Channels': [
{
'Arn': 'string',
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Destinations': [
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
'EgressEndpoints': [
{
'SourceIp': 'string'
},
],
'Id': 'string',
'InputAttachments': [
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {},
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
'InputSpecification': {
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
'LogLevel': 'ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
'Name': 'string',
'PipelinesRunningCount': 123,
'RoleArn': 'string',
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED'|'UPDATING'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- An array of channels
Channels (list) -- Placeholder documentation for __listOfChannelSummary
(dict) -- Placeholder documentation for ChannelSummary
Arn (string) -- The unique arn of the channel.
ChannelClass (string) -- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Destinations (list) -- A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
EgressEndpoints (list) -- The endpoints where outgoing connections initiate from
(dict) -- Placeholder documentation for ChannelEgressEndpoint
SourceIp (string) -- Public IP of where a channel's output comes from
Id (string) -- The unique id of the channel.
InputAttachments (list) -- List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
InputSpecification (dict) -- Placeholder documentation for InputSpecification
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
LogLevel (string) -- The log level being written to CloudWatch Logs.
Name (string) -- The name of the channel. (user-mutable)
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
RoleArn (string) -- The Amazon Resource Name (ARN) of the role assumed when running the Channel.
State (string) -- Placeholder documentation for ChannelState
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
NextToken (string) -- Placeholder documentation for __string
{'Duration': 'string'}
Response {'Offerings': {'ResourceSpecification': {'Resolution': ['FHD'],
'ResourceType': ['MULTIPLEX']}}}
List offerings available for purchase.
See also: AWS API Documentation
Request Syntax
client.list_offerings(
ChannelClass='string',
ChannelConfiguration='string',
Codec='string',
Duration='string',
MaxResults=123,
MaximumBitrate='string',
MaximumFramerate='string',
NextToken='string',
Resolution='string',
ResourceType='string',
SpecialFeature='string',
VideoQuality='string'
)
string
Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
string
Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)
string
Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'
string
Filter by offering duration, e.g. '12'
integer
Placeholder documentation for MaxResults
string
Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
string
Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
string
Placeholder documentation for __string
string
Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
string
Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
string
Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
string
Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
dict
Response Syntax
{
'NextToken': 'string',
'Offerings': [
{
'Arn': 'string',
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'FixedPrice': 123.0,
'OfferingDescription': 'string',
'OfferingId': 'string',
'OfferingType': 'NO_UPFRONT',
'Region': 'string',
'ResourceSpecification': {
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
'Resolution': 'SD'|'HD'|'FHD'|'UHD',
'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
},
'UsagePrice': 123.0
},
]
}
Response Structure
(dict) -- List of offerings
NextToken (string) -- Token to retrieve the next page of results
Offerings (list) -- List of offerings
(dict) -- Reserved resources available for purchase
Arn (string) -- Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'
CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
Duration (integer) -- Lease duration, e.g. '12'
DurationUnits (string) -- Units for duration, e.g. 'MONTHS'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
OfferingId (string) -- Unique offering ID, e.g. '87654321'
OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'
Region (string) -- AWS region, e.g. 'us-west-2'
ResourceSpecification (dict) -- Resource configuration details
ChannelClass (string) -- Channel class, e.g. 'STANDARD'
Codec (string) -- Codec, e.g. 'AVC'
MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'
MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
Resolution (string) -- Resolution, e.g. 'HD'
ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
{'Reservations': {'ResourceSpecification': {'Resolution': ['FHD'],
'ResourceType': ['MULTIPLEX']}}}
List purchased reservations.
See also: AWS API Documentation
Request Syntax
client.list_reservations(
ChannelClass='string',
Codec='string',
MaxResults=123,
MaximumBitrate='string',
MaximumFramerate='string',
NextToken='string',
Resolution='string',
ResourceType='string',
SpecialFeature='string',
VideoQuality='string'
)
string
Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
string
Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'
integer
Placeholder documentation for MaxResults
string
Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
string
Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
string
Placeholder documentation for __string
string
Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
string
Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
string
Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
string
Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
dict
Response Syntax
{
'NextToken': 'string',
'Reservations': [
{
'Arn': 'string',
'Count': 123,
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'FixedPrice': 123.0,
'Name': 'string',
'OfferingDescription': 'string',
'OfferingId': 'string',
'OfferingType': 'NO_UPFRONT',
'Region': 'string',
'ReservationId': 'string',
'ResourceSpecification': {
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
'Resolution': 'SD'|'HD'|'FHD'|'UHD',
'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
},
'Start': 'string',
'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
'Tags': {
'string': 'string'
},
'UsagePrice': 123.0
},
]
}
Response Structure
(dict) -- List of reservations
NextToken (string) -- Token to retrieve the next page of results
Reservations (list) -- List of reservations
(dict) -- Reserved resources available to use
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
Duration (integer) -- Lease duration, e.g. '12'
DurationUnits (string) -- Units for duration, e.g. 'MONTHS'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
OfferingId (string) -- Unique offering ID, e.g. '87654321'
OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'
Region (string) -- AWS region, e.g. 'us-west-2'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
ChannelClass (string) -- Channel class, e.g. 'STANDARD'
Codec (string) -- Codec, e.g. 'AVC'
MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'
MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
Resolution (string) -- Resolution, e.g. 'HD'
ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
Tags (dict) -- A collection of key-value pairs
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
{'Reservation': {'ResourceSpecification': {'Resolution': ['FHD'],
'ResourceType': ['MULTIPLEX']}}}
Purchase an offering and create a reservation.
See also: AWS API Documentation
Request Syntax
client.purchase_offering(
Count=123,
Name='string',
OfferingId='string',
RequestId='string',
Start='string',
Tags={
'string': 'string'
}
)
integer
[REQUIRED] Number of resources
string
Name for the new reservation
string
[REQUIRED] Offering to purchase, e.g. '87654321'
string
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.This field is autopopulated if not provided.
string
Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.
dict
A collection of key-value pairs
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
dict
Response Syntax
{
'Reservation': {
'Arn': 'string',
'Count': 123,
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'FixedPrice': 123.0,
'Name': 'string',
'OfferingDescription': 'string',
'OfferingId': 'string',
'OfferingType': 'NO_UPFRONT',
'Region': 'string',
'ReservationId': 'string',
'ResourceSpecification': {
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
'Resolution': 'SD'|'HD'|'FHD'|'UHD',
'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
},
'Start': 'string',
'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
'Tags': {
'string': 'string'
},
'UsagePrice': 123.0
}
}
Response Structure
(dict) -- Purchased reservation
Reservation (dict) -- Reserved resources available to use
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
Duration (integer) -- Lease duration, e.g. '12'
DurationUnits (string) -- Units for duration, e.g. 'MONTHS'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
OfferingId (string) -- Unique offering ID, e.g. '87654321'
OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'
Region (string) -- AWS region, e.g. 'us-west-2'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
ChannelClass (string) -- Channel class, e.g. 'STANDARD'
Codec (string) -- Codec, e.g. 'AVC'
MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'
MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
Resolution (string) -- Resolution, e.g. 'HD'
ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
Tags (dict) -- A collection of key-value pairs
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'
{'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}
Starts an existing channel
See also: AWS API Documentation
Request Syntax
client.start_channel(
ChannelId='string'
)
string
[REQUIRED] A request to start a channel
dict
Response Syntax
{
'Arn': 'string',
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Destinations': [
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
'EgressEndpoints': [
{
'SourceIp': 'string'
},
],
'EncoderSettings': {
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {},
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {},
'EmbeddedPlusScte20DestinationSettings': {},
'RtmpCaptionInfoDestinationSettings': {},
'Scte20PlusEmbeddedDestinationSettings': {},
'Scte27DestinationSettings': {},
'SmpteTtDestinationSettings': {},
'TeletextDestinationSettings': {},
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {},
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {},
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Rec601Settings': {},
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {},
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
'Id': 'string',
'InputAttachments': [
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {},
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
'InputSpecification': {
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
'LogLevel': 'ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
'Name': 'string',
'PipelineDetails': [
{
'ActiveInputAttachmentName': 'string',
'ActiveInputSwitchActionName': 'string',
'PipelineId': 'string'
},
],
'PipelinesRunningCount': 123,
'RoleArn': 'string',
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED'|'UPDATING'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- Successfully initiated start of the channel.
Arn (string) -- The unique arn of the channel.
ChannelClass (string) -- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Destinations (list) -- A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
EgressEndpoints (list) -- The endpoints where outgoing connections initiate from
(dict) -- Placeholder documentation for ChannelEgressEndpoint
SourceIp (string) -- Public IP of where a channel's output comes from
EncoderSettings (dict) -- Encoder Settings
AudioDescriptions (list) -- Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- The index of the input channel used as a source.
OutputChannel (integer) -- The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Id (string) -- The unique id of the channel.
InputAttachments (list) -- List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
InputSpecification (dict) -- Placeholder documentation for InputSpecification
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
LogLevel (string) -- The log level being written to CloudWatch Logs.
Name (string) -- The name of the channel. (user-mutable)
PipelineDetails (list) -- Runtime details for the pipelines of a running channel.
(dict) -- Runtime details of a pipeline when a channel is running.
ActiveInputAttachmentName (string) -- The name of the active input attachment currently being ingested by this pipeline.
ActiveInputSwitchActionName (string) -- The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
PipelineId (string) -- Pipeline ID
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
RoleArn (string) -- The Amazon Resource Name (ARN) of the role assumed when running the Channel.
State (string) -- Placeholder documentation for ChannelState
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
{'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}
Stops a running channel
See also: AWS API Documentation
Request Syntax
client.stop_channel(
ChannelId='string'
)
string
[REQUIRED] A request to stop a running channel
dict
Response Syntax
{
'Arn': 'string',
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Destinations': [
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
'EgressEndpoints': [
{
'SourceIp': 'string'
},
],
'EncoderSettings': {
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {},
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {},
'EmbeddedPlusScte20DestinationSettings': {},
'RtmpCaptionInfoDestinationSettings': {},
'Scte20PlusEmbeddedDestinationSettings': {},
'Scte27DestinationSettings': {},
'SmpteTtDestinationSettings': {},
'TeletextDestinationSettings': {},
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {},
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {},
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Rec601Settings': {},
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {},
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
'Id': 'string',
'InputAttachments': [
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {},
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
'InputSpecification': {
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
'LogLevel': 'ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
'Name': 'string',
'PipelineDetails': [
{
'ActiveInputAttachmentName': 'string',
'ActiveInputSwitchActionName': 'string',
'PipelineId': 'string'
},
],
'PipelinesRunningCount': 123,
'RoleArn': 'string',
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED'|'UPDATING'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- Successfully initiated stop of the channel.
Arn (string) -- The unique arn of the channel.
ChannelClass (string) -- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Destinations (list) -- A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
EgressEndpoints (list) -- The endpoints where outgoing connections initiate from
(dict) -- Placeholder documentation for ChannelEgressEndpoint
SourceIp (string) -- Public IP of where a channel's output comes from
EncoderSettings (dict) -- Encoder Settings
AudioDescriptions (list) -- Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- The index of the input channel used as a source.
OutputChannel (integer) -- The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Id (string) -- The unique id of the channel.
InputAttachments (list) -- List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
InputSpecification (dict) -- Placeholder documentation for InputSpecification
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
LogLevel (string) -- The log level being written to CloudWatch Logs.
Name (string) -- The name of the channel. (user-mutable)
PipelineDetails (list) -- Runtime details for the pipelines of a running channel.
(dict) -- Runtime details of a pipeline when a channel is running.
ActiveInputAttachmentName (string) -- The name of the active input attachment currently being ingested by this pipeline.
ActiveInputSwitchActionName (string) -- The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
PipelineId (string) -- Pipeline ID
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
RoleArn (string) -- The Amazon Resource Name (ARN) of the role assumed when running the Channel.
State (string) -- Placeholder documentation for ChannelState
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
{'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}
Response {'Channel': {'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}}
Updates a channel.
See also: AWS API Documentation
Request Syntax
client.update_channel(
ChannelId='string',
Destinations=[
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
EncoderSettings={
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {}
,
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {}
,
'EmbeddedPlusScte20DestinationSettings': {}
,
'RtmpCaptionInfoDestinationSettings': {}
,
'Scte20PlusEmbeddedDestinationSettings': {}
,
'Scte27DestinationSettings': {}
,
'SmpteTtDestinationSettings': {}
,
'TeletextDestinationSettings': {}
,
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {}
,
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {}
,
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {}
,
'Rec601Settings': {}
,
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {}
,
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {}
,
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
InputAttachments=[
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {}
,
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
InputSpecification={
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
LogLevel='ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
Name='string',
RoleArn='string'
)
string
[REQUIRED] channel ID
list
A list of output destinations for this channel.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
dict
The encoder settings for this channel.
AudioDescriptions (list) -- [REQUIRED] Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- [REQUIRED] The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- [REQUIRED] The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- [REQUIRED] Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- [REQUIRED] Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- [REQUIRED] Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- [REQUIRED] The index of the input channel used as a source.
OutputChannel (integer) -- [REQUIRED] The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- [REQUIRED] Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- [REQUIRED] Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- [REQUIRED] Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- [REQUIRED] Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- [REQUIRED] A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- [REQUIRED] The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- [REQUIRED] The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- [REQUIRED] Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- [REQUIRED] Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- [REQUIRED] A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- [REQUIRED] Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- [REQUIRED] MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- [REQUIRED] Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- [REQUIRED] Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- [REQUIRED] Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- [REQUIRED] Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- [REQUIRED] The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- [REQUIRED] The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- [REQUIRED] Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- [REQUIRED] Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- [REQUIRED] Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- [REQUIRED] Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- [REQUIRED] The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- [REQUIRED] Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- [REQUIRED] The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- [REQUIRED] The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- [REQUIRED] Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- [REQUIRED] Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- [REQUIRED] Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- [REQUIRED] Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- [REQUIRED] The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- [REQUIRED] Framerate denominator.
FramerateNumerator (integer) -- [REQUIRED] Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- [REQUIRED] The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
list
Placeholder documentation for __listOfInputAttachment
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- [REQUIRED] The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- [REQUIRED] Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- [REQUIRED] Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- [REQUIRED] Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
dict
Specification of input for this channel (max. bitrate, resolution, codec, etc.)
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
string
The log level to write to CloudWatch Logs.
string
The name of the channel.
string
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.
dict
Response Syntax
{
'Channel': {
'Arn': 'string',
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Destinations': [
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
'EgressEndpoints': [
{
'SourceIp': 'string'
},
],
'EncoderSettings': {
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {},
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {},
'EmbeddedPlusScte20DestinationSettings': {},
'RtmpCaptionInfoDestinationSettings': {},
'Scte20PlusEmbeddedDestinationSettings': {},
'Scte27DestinationSettings': {},
'SmpteTtDestinationSettings': {},
'TeletextDestinationSettings': {},
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {},
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {},
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Rec601Settings': {},
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {},
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
'Id': 'string',
'InputAttachments': [
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {},
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
'InputSpecification': {
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
'LogLevel': 'ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
'Name': 'string',
'PipelineDetails': [
{
'ActiveInputAttachmentName': 'string',
'ActiveInputSwitchActionName': 'string',
'PipelineId': 'string'
},
],
'PipelinesRunningCount': 123,
'RoleArn': 'string',
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED'|'UPDATING'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) -- Channel is successfully updated.
Channel (dict) -- Placeholder documentation for Channel
Arn (string) -- The unique arn of the channel.
ChannelClass (string) -- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Destinations (list) -- A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
EgressEndpoints (list) -- The endpoints where outgoing connections initiate from
(dict) -- Placeholder documentation for ChannelEgressEndpoint
SourceIp (string) -- Public IP of where a channel's output comes from
EncoderSettings (dict) -- Encoder Settings
AudioDescriptions (list) -- Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- The index of the input channel used as a source.
OutputChannel (integer) -- The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Id (string) -- The unique id of the channel.
InputAttachments (list) -- List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
InputSpecification (dict) -- Placeholder documentation for InputSpecification
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
LogLevel (string) -- The log level being written to CloudWatch Logs.
Name (string) -- The name of the channel. (user-mutable)
PipelineDetails (list) -- Runtime details for the pipelines of a running channel.
(dict) -- Runtime details of a pipeline when a channel is running.
ActiveInputAttachmentName (string) -- The name of the active input attachment currently being ingested by this pipeline.
ActiveInputSwitchActionName (string) -- The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
PipelineId (string) -- Pipeline ID
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
RoleArn (string) -- The Amazon Resource Name (ARN) of the role assumed when running the Channel.
State (string) -- Placeholder documentation for ChannelState
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
{'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}}}
Response {'Channel': {'Destinations': {'MultiplexSettings': {'MultiplexId': 'string',
'ProgramName': 'string'}},
'EncoderSettings': {'NielsenConfiguration': {'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED '
'| '
'ENABLED'},
'OutputGroups': {'OutputGroupSettings': {'MultiplexGroupSettings': {}},
'Outputs': {'OutputSettings': {'ArchiveOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}},
'HlsOutputSettings': {'HlsSettings': {'StandardHlsSettings': {'M3u8Settings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}},
'MultiplexOutputSettings': {'Destination': {'DestinationRefId': 'string'}},
'UdpOutputSettings': {'ContainerSettings': {'M2tsSettings': {'NielsenId3Behavior': 'NO_PASSTHROUGH '
'| '
'PASSTHROUGH'}}}}}},
'VideoDescriptions': {'CodecSettings': {'H265Settings': {'RateControlMode': ['MULTIPLEX']}}}}}}
Changes the class of the channel.
See also: AWS API Documentation
Request Syntax
client.update_channel_class(
ChannelClass='STANDARD'|'SINGLE_PIPELINE',
ChannelId='string',
Destinations=[
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
]
)
string
[REQUIRED] The channel class that you wish to update this channel to use.
string
[REQUIRED] Channel Id of the channel whose class should be updated.
list
A list of output destinations for this channel.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
dict
Response Syntax
{
'Channel': {
'Arn': 'string',
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Destinations': [
{
'Id': 'string',
'MediaPackageSettings': [
{
'ChannelId': 'string'
},
],
'MultiplexSettings': {
'MultiplexId': 'string',
'ProgramName': 'string'
},
'Settings': [
{
'PasswordParam': 'string',
'StreamName': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
],
'EgressEndpoints': [
{
'SourceIp': 'string'
},
],
'EncoderSettings': {
'AudioDescriptions': [
{
'AudioNormalizationSettings': {
'Algorithm': 'ITU_1770_1'|'ITU_1770_2',
'AlgorithmControl': 'CORRECT_AUDIO',
'TargetLkfs': 123.0
},
'AudioSelectorName': 'string',
'AudioType': 'CLEAN_EFFECTS'|'HEARING_IMPAIRED'|'UNDEFINED'|'VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'CodecSettings': {
'AacSettings': {
'Bitrate': 123.0,
'CodingMode': 'AD_RECEIVER_MIX'|'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_5_1',
'InputType': 'BROADCASTER_MIXED_AD'|'NORMAL',
'Profile': 'HEV1'|'HEV2'|'LC',
'RateControlMode': 'CBR'|'VBR',
'RawFormat': 'LATM_LOAS'|'NONE',
'SampleRate': 123.0,
'Spec': 'MPEG2'|'MPEG4',
'VbrQuality': 'HIGH'|'LOW'|'MEDIUM_HIGH'|'MEDIUM_LOW'
},
'Ac3Settings': {
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'DIALOGUE'|'EMERGENCY'|'HEARING_IMPAIRED'|'MUSIC_AND_EFFECTS'|'VISUALLY_IMPAIRED'|'VOICE_OVER',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_1_1'|'CODING_MODE_2_0'|'CODING_MODE_3_2_LFE',
'Dialnorm': 123,
'DrcProfile': 'FILM_STANDARD'|'NONE',
'LfeFilter': 'DISABLED'|'ENABLED',
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED'
},
'Eac3Settings': {
'AttenuationControl': 'ATTENUATE_3_DB'|'NONE',
'Bitrate': 123.0,
'BitstreamMode': 'COMMENTARY'|'COMPLETE_MAIN'|'EMERGENCY'|'HEARING_IMPAIRED'|'VISUALLY_IMPAIRED',
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0'|'CODING_MODE_3_2',
'DcFilter': 'DISABLED'|'ENABLED',
'Dialnorm': 123,
'DrcLine': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'DrcRf': 'FILM_LIGHT'|'FILM_STANDARD'|'MUSIC_LIGHT'|'MUSIC_STANDARD'|'NONE'|'SPEECH',
'LfeControl': 'LFE'|'NO_LFE',
'LfeFilter': 'DISABLED'|'ENABLED',
'LoRoCenterMixLevel': 123.0,
'LoRoSurroundMixLevel': 123.0,
'LtRtCenterMixLevel': 123.0,
'LtRtSurroundMixLevel': 123.0,
'MetadataControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'PassthroughControl': 'NO_PASSTHROUGH'|'WHEN_POSSIBLE',
'PhaseControl': 'NO_SHIFT'|'SHIFT_90_DEGREES',
'StereoDownmix': 'DPL2'|'LO_RO'|'LT_RT'|'NOT_INDICATED',
'SurroundExMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED',
'SurroundMode': 'DISABLED'|'ENABLED'|'NOT_INDICATED'
},
'Mp2Settings': {
'Bitrate': 123.0,
'CodingMode': 'CODING_MODE_1_0'|'CODING_MODE_2_0',
'SampleRate': 123.0
},
'PassThroughSettings': {}
},
'LanguageCode': 'string',
'LanguageCodeControl': 'FOLLOW_INPUT'|'USE_CONFIGURED',
'Name': 'string',
'RemixSettings': {
'ChannelMappings': [
{
'InputChannelLevels': [
{
'Gain': 123,
'InputChannel': 123
},
],
'OutputChannel': 123
},
],
'ChannelsIn': 123,
'ChannelsOut': 123
},
'StreamName': 'string'
},
],
'AvailBlanking': {
'AvailBlankingImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'State': 'DISABLED'|'ENABLED'
},
'AvailConfiguration': {
'AvailSettings': {
'Scte35SpliceInsert': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
},
'Scte35TimeSignalApos': {
'AdAvailOffset': 123,
'NoRegionalBlackoutFlag': 'FOLLOW'|'IGNORE',
'WebDeliveryAllowedFlag': 'FOLLOW'|'IGNORE'
}
}
},
'BlackoutSlate': {
'BlackoutSlateImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkEndBlackout': 'DISABLED'|'ENABLED',
'NetworkEndBlackoutImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'NetworkId': 'string',
'State': 'DISABLED'|'ENABLED'
},
'CaptionDescriptions': [
{
'CaptionSelectorName': 'string',
'DestinationSettings': {
'AribDestinationSettings': {},
'BurnInDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'DvbSubDestinationSettings': {
'Alignment': 'CENTERED'|'LEFT'|'SMART',
'BackgroundColor': 'BLACK'|'NONE'|'WHITE',
'BackgroundOpacity': 123,
'Font': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'FontColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'FontOpacity': 123,
'FontResolution': 123,
'FontSize': 'string',
'OutlineColor': 'BLACK'|'BLUE'|'GREEN'|'RED'|'WHITE'|'YELLOW',
'OutlineSize': 123,
'ShadowColor': 'BLACK'|'NONE'|'WHITE',
'ShadowOpacity': 123,
'ShadowXOffset': 123,
'ShadowYOffset': 123,
'TeletextGridControl': 'FIXED'|'SCALED',
'XPosition': 123,
'YPosition': 123
},
'EmbeddedDestinationSettings': {},
'EmbeddedPlusScte20DestinationSettings': {},
'RtmpCaptionInfoDestinationSettings': {},
'Scte20PlusEmbeddedDestinationSettings': {},
'Scte27DestinationSettings': {},
'SmpteTtDestinationSettings': {},
'TeletextDestinationSettings': {},
'TtmlDestinationSettings': {
'StyleControl': 'PASSTHROUGH'|'USE_CONFIGURED'
},
'WebvttDestinationSettings': {}
},
'LanguageCode': 'string',
'LanguageDescription': 'string',
'Name': 'string'
},
],
'GlobalConfiguration': {
'InitialAudioGain': 123,
'InputEndAction': 'NONE'|'SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior': {
'BlackFrameMsec': 123,
'InputLossImageColor': 'string',
'InputLossImageSlate': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'InputLossImageType': 'COLOR'|'SLATE',
'RepeatFrameMsec': 123
},
'OutputLockingMode': 'EPOCH_LOCKING'|'PIPELINE_LOCKING',
'OutputTimingSource': 'INPUT_CLOCK'|'SYSTEM_CLOCK',
'SupportLowFramerateInputs': 'DISABLED'|'ENABLED'
},
'NielsenConfiguration': {
'DistributorId': 'string',
'NielsenPcmToId3Tagging': 'DISABLED'|'ENABLED'
},
'OutputGroups': [
{
'Name': 'string',
'OutputGroupSettings': {
'ArchiveGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
},
'RolloverInterval': 123
},
'FrameCaptureGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'HlsGroupSettings': {
'AdMarkers': [
'ADOBE'|'ELEMENTAL'|'ELEMENTAL_SCTE35',
],
'BaseUrlContent': 'string',
'BaseUrlManifest': 'string',
'CaptionLanguageMappings': [
{
'CaptionChannel': 123,
'LanguageCode': 'string',
'LanguageDescription': 'string'
},
],
'CaptionLanguageSetting': 'INSERT'|'NONE'|'OMIT',
'ClientCache': 'DISABLED'|'ENABLED',
'CodecSpecification': 'RFC_4281'|'RFC_6381',
'ConstantIv': 'string',
'Destination': {
'DestinationRefId': 'string'
},
'DirectoryStructure': 'SINGLE_DIRECTORY'|'SUBDIRECTORY_PER_STREAM',
'EncryptionType': 'AES128'|'SAMPLE_AES',
'HlsCdnSettings': {
'HlsAkamaiSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123,
'Salt': 'string',
'Token': 'string'
},
'HlsBasicPutSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'NumRetries': 123,
'RestartDelay': 123
},
'HlsMediaStoreSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'MediaStoreStorageClass': 'TEMPORAL',
'NumRetries': 123,
'RestartDelay': 123
},
'HlsWebdavSettings': {
'ConnectionRetryInterval': 123,
'FilecacheDuration': 123,
'HttpTransferMode': 'CHUNKED'|'NON_CHUNKED',
'NumRetries': 123,
'RestartDelay': 123
}
},
'IFrameOnlyPlaylists': 'DISABLED'|'STANDARD',
'IndexNSegments': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'IvInManifest': 'EXCLUDE'|'INCLUDE',
'IvSource': 'EXPLICIT'|'FOLLOWS_SEGMENT_NUMBER',
'KeepSegments': 123,
'KeyFormat': 'string',
'KeyFormatVersions': 'string',
'KeyProviderSettings': {
'StaticKeySettings': {
'KeyProviderServer': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'StaticKeyValue': 'string'
}
},
'ManifestCompression': 'GZIP'|'NONE',
'ManifestDurationFormat': 'FLOATING_POINT'|'INTEGER',
'MinSegmentLength': 123,
'Mode': 'LIVE'|'VOD',
'OutputSelection': 'MANIFESTS_AND_SEGMENTS'|'SEGMENTS_ONLY',
'ProgramDateTime': 'EXCLUDE'|'INCLUDE',
'ProgramDateTimePeriod': 123,
'RedundantManifest': 'DISABLED'|'ENABLED',
'SegmentLength': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory': 123,
'StreamInfResolution': 'EXCLUDE'|'INCLUDE',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123,
'TimestampDeltaMilliseconds': 123,
'TsFileMode': 'SEGMENTED_FILES'|'SINGLE_FILE'
},
'MediaPackageGroupSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'MsSmoothGroupSettings': {
'AcquisitionPointId': 'string',
'AudioOnlyTimecodeControl': 'PASSTHROUGH'|'USE_CONFIGURED_CLOCK',
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'EventId': 'string',
'EventIdMode': 'NO_EVENT_ID'|'USE_CONFIGURED'|'USE_TIMESTAMP',
'EventStopBehavior': 'NONE'|'SEND_EOS',
'FilecacheDuration': 123,
'FragmentLength': 123,
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'NumRetries': 123,
'RestartDelay': 123,
'SegmentationMode': 'USE_INPUT_SEGMENTATION'|'USE_SEGMENT_DURATION',
'SendDelayMs': 123,
'SparseTrackType': 'NONE'|'SCTE_35',
'StreamManifestBehavior': 'DO_NOT_SEND'|'SEND',
'TimestampOffset': 'string',
'TimestampOffsetMode': 'USE_CONFIGURED_OFFSET'|'USE_EVENT_START_DATE'
},
'MultiplexGroupSettings': {},
'RtmpGroupSettings': {
'AuthenticationScheme': 'AKAMAI'|'COMMON',
'CacheFullBehavior': 'DISCONNECT_IMMEDIATELY'|'WAIT_FOR_SERVER',
'CacheLength': 123,
'CaptionData': 'ALL'|'FIELD1_608'|'FIELD1_AND_FIELD2_608',
'InputLossAction': 'EMIT_OUTPUT'|'PAUSE_OUTPUT',
'RestartDelay': 123
},
'UdpGroupSettings': {
'InputLossAction': 'DROP_PROGRAM'|'DROP_TS'|'EMIT_PROGRAM',
'TimedMetadataId3Frame': 'NONE'|'PRIV'|'TDRL',
'TimedMetadataId3Period': 123
}
},
'Outputs': [
{
'AudioDescriptionNames': [
'string',
],
'CaptionDescriptionNames': [
'string',
],
'OutputName': 'string',
'OutputSettings': {
'ArchiveOutputSettings': {
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Extension': 'string',
'NameModifier': 'string'
},
'FrameCaptureOutputSettings': {
'NameModifier': 'string'
},
'HlsOutputSettings': {
'HlsSettings': {
'AudioOnlyHlsSettings': {
'AudioGroupId': 'string',
'AudioOnlyImage': {
'PasswordParam': 'string',
'Uri': 'string',
'Username': 'string'
},
'AudioTrackType': 'ALTERNATE_AUDIO_AUTO_SELECT'|'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT'|'ALTERNATE_AUDIO_NOT_AUTO_SELECT'|'AUDIO_ONLY_VARIANT_STREAM'
},
'StandardHlsSettings': {
'AudioRenditionSets': 'string',
'M3u8Settings': {
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'EcmPid': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'Scte35Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'Scte35Pid': 'string',
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
}
},
'NameModifier': 'string',
'SegmentModifier': 'string'
},
'MediaPackageOutputSettings': {},
'MsSmoothOutputSettings': {
'H265PackagingType': 'HEV1'|'HVC1',
'NameModifier': 'string'
},
'MultiplexOutputSettings': {
'Destination': {
'DestinationRefId': 'string'
}
},
'RtmpOutputSettings': {
'CertificateMode': 'SELF_SIGNED'|'VERIFY_AUTHENTICITY',
'ConnectionRetryInterval': 123,
'Destination': {
'DestinationRefId': 'string'
},
'NumRetries': 123
},
'UdpOutputSettings': {
'BufferMsec': 123,
'ContainerSettings': {
'M2tsSettings': {
'AbsentInputAudioBehavior': 'DROP'|'ENCODE_SILENCE',
'Arib': 'DISABLED'|'ENABLED',
'AribCaptionsPid': 'string',
'AribCaptionsPidControl': 'AUTO'|'USE_CONFIGURED',
'AudioBufferModel': 'ATSC'|'DVB',
'AudioFramesPerPes': 123,
'AudioPids': 'string',
'AudioStreamType': 'ATSC'|'DVB',
'Bitrate': 123,
'BufferModel': 'MULTIPLEX'|'NONE',
'CcDescriptor': 'DISABLED'|'ENABLED',
'DvbNitSettings': {
'NetworkId': 123,
'NetworkName': 'string',
'RepInterval': 123
},
'DvbSdtSettings': {
'OutputSdt': 'SDT_FOLLOW'|'SDT_FOLLOW_IF_PRESENT'|'SDT_MANUAL'|'SDT_NONE',
'RepInterval': 123,
'ServiceName': 'string',
'ServiceProviderName': 'string'
},
'DvbSubPids': 'string',
'DvbTdtSettings': {
'RepInterval': 123
},
'DvbTeletextPid': 'string',
'Ebif': 'NONE'|'PASSTHROUGH',
'EbpAudioInterval': 'VIDEO_AND_FIXED_INTERVALS'|'VIDEO_INTERVAL',
'EbpLookaheadMs': 123,
'EbpPlacement': 'VIDEO_AND_AUDIO_PIDS'|'VIDEO_PID',
'EcmPid': 'string',
'EsRateInPes': 'EXCLUDE'|'INCLUDE',
'EtvPlatformPid': 'string',
'EtvSignalPid': 'string',
'FragmentTime': 123.0,
'Klv': 'NONE'|'PASSTHROUGH',
'KlvDataPids': 'string',
'NielsenId3Behavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'NullPacketBitrate': 123.0,
'PatInterval': 123,
'PcrControl': 'CONFIGURED_PCR_PERIOD'|'PCR_EVERY_PES_PACKET',
'PcrPeriod': 123,
'PcrPid': 'string',
'PmtInterval': 123,
'PmtPid': 'string',
'ProgramNum': 123,
'RateMode': 'CBR'|'VBR',
'Scte27Pids': 'string',
'Scte35Control': 'NONE'|'PASSTHROUGH',
'Scte35Pid': 'string',
'SegmentationMarkers': 'EBP'|'EBP_LEGACY'|'NONE'|'PSI_SEGSTART'|'RAI_ADAPT'|'RAI_SEGSTART',
'SegmentationStyle': 'MAINTAIN_CADENCE'|'RESET_CADENCE',
'SegmentationTime': 123.0,
'TimedMetadataBehavior': 'NO_PASSTHROUGH'|'PASSTHROUGH',
'TimedMetadataPid': 'string',
'TransportStreamId': 123,
'VideoPid': 'string'
}
},
'Destination': {
'DestinationRefId': 'string'
},
'FecOutputSettings': {
'ColumnDepth': 123,
'IncludeFec': 'COLUMN'|'COLUMN_AND_ROW',
'RowLength': 123
}
}
},
'VideoDescriptionName': 'string'
},
]
},
],
'TimecodeConfig': {
'Source': 'EMBEDDED'|'SYSTEMCLOCK'|'ZEROBASED',
'SyncThreshold': 123
},
'VideoDescriptions': [
{
'CodecSettings': {
'FrameCaptureSettings': {
'CaptureInterval': 123
},
'H264Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'Bitrate': 123,
'BufFillPct': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Rec601Settings': {},
'Rec709Settings': {}
},
'EntropyEncoding': 'CABAC'|'CAVLC',
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopBReference': 'DISABLED'|'ENABLED',
'GopClosedCadence': 123,
'GopNumBFrames': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H264_LEVEL_1'|'H264_LEVEL_1_1'|'H264_LEVEL_1_2'|'H264_LEVEL_1_3'|'H264_LEVEL_2'|'H264_LEVEL_2_1'|'H264_LEVEL_2_2'|'H264_LEVEL_3'|'H264_LEVEL_3_1'|'H264_LEVEL_3_2'|'H264_LEVEL_4'|'H264_LEVEL_4_1'|'H264_LEVEL_4_2'|'H264_LEVEL_5'|'H264_LEVEL_5_1'|'H264_LEVEL_5_2'|'H264_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'NumRefFrames': 123,
'ParControl': 'INITIALIZE_FROM_SOURCE'|'SPECIFIED',
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'BASELINE'|'HIGH'|'HIGH_10BIT'|'HIGH_422'|'HIGH_422_10BIT'|'MAIN',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR'|'VBR',
'ScanType': 'INTERLACED'|'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Softness': 123,
'SpatialAq': 'DISABLED'|'ENABLED',
'SubgopLength': 'DYNAMIC'|'FIXED',
'Syntax': 'DEFAULT'|'RP2027',
'TemporalAq': 'DISABLED'|'ENABLED',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
},
'H265Settings': {
'AdaptiveQuantization': 'HIGH'|'HIGHER'|'LOW'|'MAX'|'MEDIUM'|'OFF',
'AfdSignaling': 'AUTO'|'FIXED'|'NONE',
'AlternativeTransferFunction': 'INSERT'|'OMIT',
'Bitrate': 123,
'BufSize': 123,
'ColorMetadata': 'IGNORE'|'INSERT',
'ColorSpaceSettings': {
'ColorSpacePassthroughSettings': {},
'Hdr10Settings': {
'MaxCll': 123,
'MaxFall': 123
},
'Rec601Settings': {},
'Rec709Settings': {}
},
'FixedAfd': 'AFD_0000'|'AFD_0010'|'AFD_0011'|'AFD_0100'|'AFD_1000'|'AFD_1001'|'AFD_1010'|'AFD_1011'|'AFD_1101'|'AFD_1110'|'AFD_1111',
'FlickerAq': 'DISABLED'|'ENABLED',
'FramerateDenominator': 123,
'FramerateNumerator': 123,
'GopClosedCadence': 123,
'GopSize': 123.0,
'GopSizeUnits': 'FRAMES'|'SECONDS',
'Level': 'H265_LEVEL_1'|'H265_LEVEL_2'|'H265_LEVEL_2_1'|'H265_LEVEL_3'|'H265_LEVEL_3_1'|'H265_LEVEL_4'|'H265_LEVEL_4_1'|'H265_LEVEL_5'|'H265_LEVEL_5_1'|'H265_LEVEL_5_2'|'H265_LEVEL_6'|'H265_LEVEL_6_1'|'H265_LEVEL_6_2'|'H265_LEVEL_AUTO',
'LookAheadRateControl': 'HIGH'|'LOW'|'MEDIUM',
'MaxBitrate': 123,
'MinIInterval': 123,
'ParDenominator': 123,
'ParNumerator': 123,
'Profile': 'MAIN'|'MAIN_10BIT',
'QvbrQualityLevel': 123,
'RateControlMode': 'CBR'|'MULTIPLEX'|'QVBR',
'ScanType': 'PROGRESSIVE',
'SceneChangeDetect': 'DISABLED'|'ENABLED',
'Slices': 123,
'Tier': 'HIGH'|'MAIN',
'TimecodeInsertion': 'DISABLED'|'PIC_TIMING_SEI'
}
},
'Height': 123,
'Name': 'string',
'RespondToAfd': 'NONE'|'PASSTHROUGH'|'RESPOND',
'ScalingBehavior': 'DEFAULT'|'STRETCH_TO_OUTPUT',
'Sharpness': 123,
'Width': 123
},
]
},
'Id': 'string',
'InputAttachments': [
{
'InputAttachmentName': 'string',
'InputId': 'string',
'InputSettings': {
'AudioSelectors': [
{
'Name': 'string',
'SelectorSettings': {
'AudioLanguageSelection': {
'LanguageCode': 'string',
'LanguageSelectionPolicy': 'LOOSE'|'STRICT'
},
'AudioPidSelection': {
'Pid': 123
}
}
},
],
'CaptionSelectors': [
{
'LanguageCode': 'string',
'Name': 'string',
'SelectorSettings': {
'AribSourceSettings': {},
'DvbSubSourceSettings': {
'Pid': 123
},
'EmbeddedSourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Scte20Detection': 'AUTO'|'OFF',
'Source608ChannelNumber': 123,
'Source608TrackNumber': 123
},
'Scte20SourceSettings': {
'Convert608To708': 'DISABLED'|'UPCONVERT',
'Source608ChannelNumber': 123
},
'Scte27SourceSettings': {
'Pid': 123
},
'TeletextSourceSettings': {
'PageNumber': 'string'
}
}
},
],
'DeblockFilter': 'DISABLED'|'ENABLED',
'DenoiseFilter': 'DISABLED'|'ENABLED',
'FilterStrength': 123,
'InputFilter': 'AUTO'|'DISABLED'|'FORCED',
'NetworkInputSettings': {
'HlsInputSettings': {
'Bandwidth': 123,
'BufferSegments': 123,
'Retries': 123,
'RetryInterval': 123
},
'ServerValidation': 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME'|'CHECK_CRYPTOGRAPHY_ONLY'
},
'SourceEndBehavior': 'CONTINUE'|'LOOP',
'VideoSelector': {
'ColorSpace': 'FOLLOW'|'REC_601'|'REC_709',
'ColorSpaceUsage': 'FALLBACK'|'FORCE',
'SelectorSettings': {
'VideoSelectorPid': {
'Pid': 123
},
'VideoSelectorProgramId': {
'ProgramId': 123
}
}
}
}
},
],
'InputSpecification': {
'Codec': 'MPEG2'|'AVC'|'HEVC',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'Resolution': 'SD'|'HD'|'UHD'
},
'LogLevel': 'ERROR'|'WARNING'|'INFO'|'DEBUG'|'DISABLED',
'Name': 'string',
'PipelineDetails': [
{
'ActiveInputAttachmentName': 'string',
'ActiveInputSwitchActionName': 'string',
'PipelineId': 'string'
},
],
'PipelinesRunningCount': 123,
'RoleArn': 'string',
'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED'|'UPDATING'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) -- The class of the channel has been successfully updated.
Channel (dict) -- Placeholder documentation for Channel
Arn (string) -- The unique arn of the channel.
ChannelClass (string) -- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Destinations (list) -- A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
(dict) -- Placeholder documentation for OutputDestination
Id (string) -- User-specified id. This is used in an output group or an output.
MediaPackageSettings (list) -- Destination settings for a MediaPackage output; one destination for both encoders.
(dict) -- MediaPackage Output Destination Settings
ChannelId (string) -- ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
MultiplexSettings (dict) -- Destination settings for a Multiplex output; one destination for both encoders.
MultiplexId (string) -- The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.
ProgramName (string) -- The program name of the Multiplex program that the encoder is providing output to.
Settings (list) -- Destination settings for a standard output; one destination for each redundant encoder.
(dict) -- Placeholder documentation for OutputDestinationSettings
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
StreamName (string) -- Stream name for RTMP destinations (URLs of type rtmp://)
Url (string) -- A URL specifying a destination
Username (string) -- username for destination
EgressEndpoints (list) -- The endpoints where outgoing connections initiate from
(dict) -- Placeholder documentation for ChannelEgressEndpoint
SourceIp (string) -- Public IP of where a channel's output comes from
EncoderSettings (dict) -- Encoder Settings
AudioDescriptions (list) -- Placeholder documentation for __listOfAudioDescription
(dict) -- Audio Description
AudioNormalizationSettings (dict) -- Advanced audio normalization settings.
Algorithm (string) -- Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
AlgorithmControl (string) -- When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
TargetLkfs (float) -- Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioSelectorName (string) -- The name of the AudioSelector used as the source for this AudioDescription.
AudioType (string) -- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
AudioTypeControl (string) -- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
CodecSettings (dict) -- Audio codec settings.
AacSettings (dict) -- Aac Settings
Bitrate (float) -- Average bitrate in bits/second. Valid values depend on rate control mode and profile.
CodingMode (string) -- Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
InputType (string) -- Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.
Profile (string) -- AAC Profile.
RateControlMode (string) -- Rate Control Mode.
RawFormat (string) -- Sets LATM / LOAS AAC output for raw containers.
SampleRate (float) -- Sample rate in Hz. Valid values depend on rate control mode and profile.
Spec (string) -- Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
VbrQuality (string) -- VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings (dict) -- Ac3 Settings
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
CodingMode (string) -- Dolby Digital coding mode. Determines number of channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
DrcProfile (string) -- If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
MetadataControl (string) -- When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
Eac3Settings (dict) -- Eac3 Settings
AttenuationControl (string) -- When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
Bitrate (float) -- Average bitrate in bits/second. Valid bitrates depend on the coding mode.
BitstreamMode (string) -- Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
CodingMode (string) -- Dolby Digital Plus coding mode. Determines number of channels.
DcFilter (string) -- When set to enabled, activates a DC highpass filter for all input channels.
Dialnorm (integer) -- Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
DrcLine (string) -- Sets the Dolby dynamic range compression profile.
DrcRf (string) -- Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
LfeControl (string) -- When encoding 3/2 audio, setting to lfe enables the LFE channel
LfeFilter (string) -- When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
LoRoCenterMixLevel (float) -- Left only/Right only center mix level. Only used for 3/2 coding mode.
LoRoSurroundMixLevel (float) -- Left only/Right only surround mix level. Only used for 3/2 coding mode.
LtRtCenterMixLevel (float) -- Left total/Right total center mix level. Only used for 3/2 coding mode.
LtRtSurroundMixLevel (float) -- Left total/Right total surround mix level. Only used for 3/2 coding mode.
MetadataControl (string) -- When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
PassthroughControl (string) -- When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
PhaseControl (string) -- When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
StereoDownmix (string) -- Stereo downmix preference. Only used for 3/2 coding mode.
SurroundExMode (string) -- When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
SurroundMode (string) -- When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
Mp2Settings (dict) -- Mp2 Settings
Bitrate (float) -- Average bitrate in bits/second.
CodingMode (string) -- The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
SampleRate (float) -- Sample rate in Hz.
PassThroughSettings (dict) -- Pass Through Settings
LanguageCode (string) -- Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
LanguageCodeControl (string) -- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
Name (string) -- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
RemixSettings (dict) -- Settings that control how input audio channels are remixed into the output audio channels.
ChannelMappings (list) -- Mapping of input channels to output channels, with appropriate gain adjustments.
(dict) -- Audio Channel Mapping
InputChannelLevels (list) -- Indices and gain values for each input channel that should be remixed into this output channel.
(dict) -- Input Channel Level
Gain (integer) -- Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
InputChannel (integer) -- The index of the input channel used as a source.
OutputChannel (integer) -- The index of the output channel being produced.
ChannelsIn (integer) -- Number of input channels to be used.
ChannelsOut (integer) -- Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
StreamName (string) -- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AvailBlanking (dict) -- Settings for ad avail blanking.
AvailBlankingImage (dict) -- Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
State (string) -- When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration (dict) -- Event-wide configuration settings for ad avail insertion.
AvailSettings (dict) -- Ad avail settings.
Scte35SpliceInsert (dict) -- Scte35 Splice Insert
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalApos (dict) -- Scte35 Time Signal Apos
AdAvailOffset (integer) -- When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
NoRegionalBlackoutFlag (string) -- When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
WebDeliveryAllowedFlag (string) -- When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
BlackoutSlate (dict) -- Settings for blackout slate.
BlackoutSlateImage (dict) -- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkEndBlackout (string) -- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
NetworkEndBlackoutImage (dict) -- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
NetworkId (string) -- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
State (string) -- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
CaptionDescriptions (list) -- Settings for caption decriptions
(dict) -- Caption Description
CaptionSelectorName (string) -- Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
DestinationSettings (dict) -- Additional settings for captions destination that depend on the destination type.
AribDestinationSettings (dict) -- Arib Destination Settings
BurnInDestinationSettings (dict) -- Burn In Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
DvbSubDestinationSettings (dict) -- Dvb Sub Destination Settings
Alignment (string) -- If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor (string) -- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
BackgroundOpacity (integer) -- Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font (dict) -- External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
FontColor (string) -- Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
FontOpacity (integer) -- Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution (integer) -- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize (string) -- When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor (string) -- Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
OutlineSize (integer) -- Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
ShadowColor (string) -- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
ShadowOpacity (integer) -- Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset (integer) -- Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
ShadowYOffset (integer) -- Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
TeletextGridControl (string) -- Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition (integer) -- Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
YPosition (integer) -- Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
EmbeddedDestinationSettings (dict) -- Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings (dict) -- Embedded Plus Scte20 Destination Settings
RtmpCaptionInfoDestinationSettings (dict) -- Rtmp Caption Info Destination Settings
Scte20PlusEmbeddedDestinationSettings (dict) -- Scte20 Plus Embedded Destination Settings
Scte27DestinationSettings (dict) -- Scte27 Destination Settings
SmpteTtDestinationSettings (dict) -- Smpte Tt Destination Settings
TeletextDestinationSettings (dict) -- Teletext Destination Settings
TtmlDestinationSettings (dict) -- Ttml Destination Settings
StyleControl (string) -- When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.
WebvttDestinationSettings (dict) -- Webvtt Destination Settings
LanguageCode (string) -- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
LanguageDescription (string) -- Human readable information to indicate captions available for players (eg. English, or Spanish).
Name (string) -- Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
GlobalConfiguration (dict) -- Configuration settings that apply to the event as a whole.
InitialAudioGain (integer) -- Value to set the initial audio gain for the Live Event.
InputEndAction (string) -- Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
InputLossBehavior (dict) -- Settings for system actions when input is lost.
BlackFrameMsec (integer) -- Documentation update needed
InputLossImageColor (string) -- When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
InputLossImageSlate (dict) -- When input loss image type is "slate" these fields specify the parameters for accessing the slate.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
InputLossImageType (string) -- Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
RepeatFrameMsec (integer) -- Documentation update needed
OutputLockingMode (string) -- Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.
OutputTimingSource (string) -- Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
SupportLowFramerateInputs (string) -- Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
NielsenConfiguration (dict) -- Nielsen configuration settings.
DistributorId (string) -- Enter the Distributor ID assigned to your organization by Nielsen.
NielsenPcmToId3Tagging (string) -- Enables Nielsen PCM to ID3 tagging
OutputGroups (list) -- Placeholder documentation for __listOfOutputGroup
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Name (string) -- Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
OutputGroupSettings (dict) -- Settings associated with the output group.
ArchiveGroupSettings (dict) -- Archive Group Settings
Destination (dict) -- A directory and base filename where archive files should be written.
DestinationRefId (string) -- Placeholder documentation for __string
RolloverInterval (integer) -- Number of seconds to write to archive file before closing and starting a new one.
FrameCaptureGroupSettings (dict) -- Frame Capture Group Settings
Destination (dict) -- The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
DestinationRefId (string) -- Placeholder documentation for __string
HlsGroupSettings (dict) -- Hls Group Settings
AdMarkers (list) -- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
(string) -- Hls Ad Markers
BaseUrlContent (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
BaseUrlManifest (string) -- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
CaptionLanguageMappings (list) -- Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
(dict) -- Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
CaptionChannel (integer) -- The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
LanguageCode (string) -- Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
LanguageDescription (string) -- Textual description of language
CaptionLanguageSetting (string) -- Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
ClientCache (string) -- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
CodecSpecification (string) -- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
ConstantIv (string) -- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
Destination (dict) -- A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
DestinationRefId (string) -- Placeholder documentation for __string
DirectoryStructure (string) -- Place segments in subdirectories.
EncryptionType (string) -- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
HlsCdnSettings (dict) -- Parameters that control interactions with the CDN.
HlsAkamaiSettings (dict) -- Hls Akamai Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
Salt (string) -- Salt for authenticated Akamai.
Token (string) -- Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings (dict) -- Hls Basic Put Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsMediaStoreSettings (dict) -- Hls Media Store Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
MediaStoreStorageClass (string) -- When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsWebdavSettings (dict) -- Hls Webdav Settings
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the CDN if the connection is lost.
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
HttpTransferMode (string) -- Specify whether or not to use chunked transfer encoding to WebDAV.
NumRetries (integer) -- Number of retry attempts that will be made before the Live Event is put into an error state.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
IFrameOnlyPlaylists (string) -- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
IndexNSegments (integer) -- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
IvInManifest (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
IvSource (string) -- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
KeepSegments (integer) -- Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
KeyFormat (string) -- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
KeyFormatVersions (string) -- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
KeyProviderSettings (dict) -- The key provider settings.
StaticKeySettings (dict) -- Static Key Settings
KeyProviderServer (dict) -- The URL of the license server used for protecting content.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
StaticKeyValue (string) -- Static key value as a 32 character hexadecimal string.
ManifestCompression (string) -- When set to gzip, compresses HLS playlist.
ManifestDurationFormat (string) -- Indicates whether the output manifest should use floating point or integer values for segment duration.
MinSegmentLength (integer) -- When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
Mode (string) -- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
OutputSelection (string) -- MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group.
ProgramDateTime (string) -- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
ProgramDateTimePeriod (integer) -- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
RedundantManifest (string) -- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
SegmentLength (integer) -- Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SegmentsPerSubdirectory (integer) -- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
StreamInfResolution (string) -- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
TimestampDeltaMilliseconds (integer) -- Provides an extra millisecond delta offset to fine tune the timestamps.
TsFileMode (string) -- SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
MediaPackageGroupSettings (dict) -- Media Package Group Settings
Destination (dict) -- MediaPackage channel destination.
DestinationRefId (string) -- Placeholder documentation for __string
MsSmoothGroupSettings (dict) -- Ms Smooth Group Settings
AcquisitionPointId (string) -- The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
AudioOnlyTimecodeControl (string) -- If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
CertificateMode (string) -- If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
Destination (dict) -- Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
DestinationRefId (string) -- Placeholder documentation for __string
EventId (string) -- MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
EventIdMode (string) -- Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.
EventStopBehavior (string) -- When set to sendEos, send EOS signal to IIS server when stopping the event
FilecacheDuration (integer) -- Size in seconds of file cache for streaming outputs.
FragmentLength (integer) -- Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
InputLossAction (string) -- Parameter that control output group behavior on input loss.
NumRetries (integer) -- Number of retry attempts.
RestartDelay (integer) -- Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
SegmentationMode (string) -- useInputSegmentation has been deprecated. The configured segment size is always used.
SendDelayMs (integer) -- Number of milliseconds to delay the output from the second pipeline.
SparseTrackType (string) -- If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
StreamManifestBehavior (string) -- When set to send, send stream manifest so publishing point doesn't start until all streams start.
TimestampOffset (string) -- Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
TimestampOffsetMode (string) -- Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset
MultiplexGroupSettings (dict) -- Multiplex Group Settings
RtmpGroupSettings (dict) -- Rtmp Group Settings
AuthenticationScheme (string) -- Authentication scheme to use when connecting with CDN
CacheFullBehavior (string) -- Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
CacheLength (integer) -- Cache length, in seconds, is used to calculate buffer size.
CaptionData (string) -- Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
InputLossAction (string) -- Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.
RestartDelay (integer) -- If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
UdpGroupSettings (dict) -- Udp Group Settings
InputLossAction (string) -- Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
TimedMetadataId3Frame (string) -- Indicates ID3 frame that has the timecode.
TimedMetadataId3Period (integer) -- Timed Metadata interval in seconds.
Outputs (list) -- Placeholder documentation for __listOfOutput
(dict) -- Output settings. There can be multiple outputs within a group.
AudioDescriptionNames (list) -- The names of the AudioDescriptions used as audio sources for this output.
(string) -- Placeholder documentation for __string
CaptionDescriptionNames (list) -- The names of the CaptionDescriptions used as caption sources for this output.
(string) -- Placeholder documentation for __string
OutputName (string) -- The name used to identify an output.
OutputSettings (dict) -- Output type-specific settings.
ArchiveOutputSettings (dict) -- Archive Output Settings
ContainerSettings (dict) -- Settings specific to the container type of the file.
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Extension (string) -- Output file extension. If excluded, this will be auto-selected from the container type.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
FrameCaptureOutputSettings (dict) -- Frame Capture Output Settings
NameModifier (string) -- Required if the output group contains more than one output. This modifier forms part of the output file name.
HlsOutputSettings (dict) -- Hls Output Settings
HlsSettings (dict) -- Settings regarding the underlying stream. These settings are different for audio-only outputs.
AudioOnlyHlsSettings (dict) -- Audio Only Hls Settings
AudioGroupId (string) -- Specifies the group to which the audio Rendition belongs.
AudioOnlyImage (dict) -- Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
PasswordParam (string) -- key used to extract the password from EC2 Parameter store
Uri (string) -- Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
Username (string) -- Documentation update needed
AudioTrackType (string) -- Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
StandardHlsSettings (dict) -- Standard Hls Settings
AudioRenditionSets (string) -- List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
M3u8Settings (dict) -- Settings information for the .m3u8 container
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
EcmPid (string) -- This parameter is unused and deprecated.
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. A value of "0" writes out the PMT once per segment file.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
Scte35Behavior (string) -- If set to passthrough, passes any SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata is passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
NameModifier (string) -- String concatenated to the end of the destination filename. Accepts "Format Identifiers":#formatIdentifierParameters.
SegmentModifier (string) -- String concatenated to end of segment filenames.
MediaPackageOutputSettings (dict) -- Media Package Output Settings
MsSmoothOutputSettings (dict) -- Ms Smooth Output Settings
H265PackagingType (string) -- Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
NameModifier (string) -- String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MultiplexOutputSettings (dict) -- Multiplex Output Settings
Destination (dict) -- Destination is a Multiplex.
DestinationRefId (string) -- Placeholder documentation for __string
RtmpOutputSettings (dict) -- Rtmp Output Settings
CertificateMode (string) -- If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
ConnectionRetryInterval (integer) -- Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
Destination (dict) -- The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
DestinationRefId (string) -- Placeholder documentation for __string
NumRetries (integer) -- Number of retry attempts.
UdpOutputSettings (dict) -- Udp Output Settings
BufferMsec (integer) -- UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
ContainerSettings (dict) -- Udp Container Settings
M2tsSettings (dict) -- M2ts Settings
AbsentInputAudioBehavior (string) -- When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
Arib (string) -- When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
AribCaptionsPid (string) -- Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
AribCaptionsPidControl (string) -- If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
AudioBufferModel (string) -- When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
AudioFramesPerPes (integer) -- The number of audio frames to insert for each PES packet.
AudioPids (string) -- Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
AudioStreamType (string) -- When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
Bitrate (integer) -- The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
BufferModel (string) -- If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
CcDescriptor (string) -- When set to enabled, generates captionServiceDescriptor in PMT.
DvbNitSettings (dict) -- Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
NetworkId (integer) -- The numeric value placed in the Network Information Table (NIT).
NetworkName (string) -- The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings (dict) -- Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
OutputSdt (string) -- Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
ServiceName (string) -- The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
ServiceProviderName (string) -- The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubPids (string) -- Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
DvbTdtSettings (dict) -- Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
RepInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream.
DvbTeletextPid (string) -- Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Ebif (string) -- If set to passthrough, passes any EBIF data from the input source to this output.
EbpAudioInterval (string) -- When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
EbpLookaheadMs (integer) -- When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
EbpPlacement (string) -- Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
EcmPid (string) -- This field is unused and deprecated.
EsRateInPes (string) -- Include or exclude the ES Rate field in the PES header.
EtvPlatformPid (string) -- Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
EtvSignalPid (string) -- Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
FragmentTime (float) -- The length in seconds of each fragment. Only used with EBP markers.
Klv (string) -- If set to passthrough, passes any KLV data from the input source to this output.
KlvDataPids (string) -- Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
NielsenId3Behavior (string) -- If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
NullPacketBitrate (float) -- Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
PatInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PcrControl (string) -- When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PcrPeriod (integer) -- Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
PcrPid (string) -- Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
PmtInterval (integer) -- The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
PmtPid (string) -- Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
ProgramNum (integer) -- The value of the program number field in the Program Map Table.
RateMode (string) -- When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
Scte27Pids (string) -- Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
Scte35Control (string) -- Optionally pass SCTE-35 signals from the input source to this output.
Scte35Pid (string) -- Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
SegmentationMarkers (string) -- Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
SegmentationStyle (string) -- The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.
SegmentationTime (float) -- The length in seconds of each segment. Required unless markers is set to None_.
TimedMetadataBehavior (string) -- When set to passthrough, timed metadata will be passed through from input to output.
TimedMetadataPid (string) -- Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
TransportStreamId (integer) -- The value of the transport stream ID field in the Program Map Table.
VideoPid (string) -- Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
Destination (dict) -- Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
DestinationRefId (string) -- Placeholder documentation for __string
FecOutputSettings (dict) -- Settings for enabling and adjusting Forward Error Correction on UDP outputs.
ColumnDepth (integer) -- Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
IncludeFec (string) -- Enables column only or column and row based FEC
RowLength (integer) -- Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
VideoDescriptionName (string) -- The name of the VideoDescription used as the source for this output.
TimecodeConfig (dict) -- Contains settings used to acquire and adjust timecode information from inputs.
Source (string) -- Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.
SyncThreshold (integer) -- Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
VideoDescriptions (list) -- Placeholder documentation for __listOfVideoDescription
(dict) -- Video settings for this stream.
CodecSettings (dict) -- Video codec settings.
FrameCaptureSettings (dict) -- Frame Capture Settings
CaptureInterval (integer) -- The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
H264Settings (dict) -- H264 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufFillPct (integer) -- Percentage of the buffer that should initially be filled (HRD buffer model).
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
EntropyEncoding (string) -- Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateControl (string) -- This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopBReference (string) -- Documentation update needed
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopNumBFrames (integer) -- Number of B-frames between reference frames.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.264 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
NumRefFrames (integer) -- Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
ParControl (string) -- This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.264 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Softness (integer) -- Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
SpatialAq (string) -- If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.
SubgopLength (string) -- If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
Syntax (string) -- Produces a bitstream compliant with SMPTE RP-2027.
TemporalAq (string) -- If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265Settings (dict) -- H265 Settings
AdaptiveQuantization (string) -- Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
AfdSignaling (string) -- Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
AlternativeTransferFunction (string) -- Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
Bitrate (integer) -- Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
BufSize (integer) -- Size of buffer (HRD buffer model) in bits.
ColorMetadata (string) -- Includes colorspace metadata in the output.
ColorSpaceSettings (dict) -- Color Space settings
ColorSpacePassthroughSettings (dict) -- Passthrough applies no color space conversion to the output
Hdr10Settings (dict) -- Hdr10 Settings
MaxCll (integer) -- Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.
MaxFall (integer) -- Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.
Rec601Settings (dict) -- Rec601 Settings
Rec709Settings (dict) -- Rec709 Settings
FixedAfd (string) -- Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
FlickerAq (string) -- If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
FramerateDenominator (integer) -- Framerate denominator.
FramerateNumerator (integer) -- Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
GopClosedCadence (integer) -- Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
GopSize (float) -- GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
GopSizeUnits (string) -- Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
Level (string) -- H.265 Level.
LookAheadRateControl (string) -- Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
MaxBitrate (integer) -- For QVBR: See the tooltip for Quality level
MinIInterval (integer) -- Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
ParDenominator (integer) -- Pixel Aspect Ratio denominator.
ParNumerator (integer) -- Pixel Aspect Ratio numerator.
Profile (string) -- H.265 Profile.
QvbrQualityLevel (integer) -- Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
RateControlMode (string) -- Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates.
ScanType (string) -- Sets the scan type of the output to progressive or top-field-first interlaced.
SceneChangeDetect (string) -- Scene change detection.
Slices (integer) -- Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
Tier (string) -- H.265 Tier.
TimecodeInsertion (string) -- Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
Height (integer) -- Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Name (string) -- The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
RespondToAfd (string) -- Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.
ScalingBehavior (string) -- STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
Sharpness (integer) -- Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
Width (integer) -- Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
Id (string) -- The unique id of the channel.
InputAttachments (list) -- List of input attachments for channel.
(dict) -- Placeholder documentation for InputAttachment
InputAttachmentName (string) -- User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
InputId (string) -- The ID of the input
InputSettings (dict) -- Settings of an input (caption selector, etc.)
AudioSelectors (list) -- Used to select the audio stream to decode for inputs that have multiple available.
(dict) -- Audio Selector
Name (string) -- The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
SelectorSettings (dict) -- The audio selector settings.
AudioLanguageSelection (dict) -- Audio Language Selection
LanguageCode (string) -- Selects a specific three-letter language code from within an audio source.
LanguageSelectionPolicy (string) -- When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioPidSelection (dict) -- Audio Pid Selection
Pid (integer) -- Selects a specific PID from within a source.
CaptionSelectors (list) -- Used to select the caption input to use for inputs that have multiple available.
(dict) -- Output groups for this Live Event. Output groups contain information about where streams should be distributed.
LanguageCode (string) -- When specified this field indicates the three letter language code of the caption track to extract from the source.
Name (string) -- Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
SelectorSettings (dict) -- Caption selector settings.
AribSourceSettings (dict) -- Arib Source Settings
DvbSubSourceSettings (dict) -- Dvb Sub Source Settings
Pid (integer) -- When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
EmbeddedSourceSettings (dict) -- Embedded Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Scte20Detection (string) -- Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Source608TrackNumber (integer) -- This field is unused and deprecated.
Scte20SourceSettings (dict) -- Scte20 Source Settings
Convert608To708 (string) -- If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
Source608ChannelNumber (integer) -- Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27SourceSettings (dict) -- Scte27 Source Settings
Pid (integer) -- The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
TeletextSourceSettings (dict) -- Teletext Source Settings
PageNumber (string) -- Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
DeblockFilter (string) -- Enable or disable the deblock filter when filtering.
DenoiseFilter (string) -- Enable or disable the denoise filter when filtering.
FilterStrength (integer) -- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
InputFilter (string) -- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
NetworkInputSettings (dict) -- Input settings.
HlsInputSettings (dict) -- Specifies HLS input settings when the uri is for a HLS manifest.
Bandwidth (integer) -- When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
BufferSegments (integer) -- When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
Retries (integer) -- The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
RetryInterval (integer) -- The number of seconds between retries when an attempt to read a manifest or segment fails.
ServerValidation (string) -- Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
SourceEndBehavior (string) -- Loop input if it is a file. This allows a file input to be streamed indefinitely.
VideoSelector (dict) -- Informs which video elementary stream to decode for input types that have multiple available.
ColorSpace (string) -- Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
ColorSpaceUsage (string) -- Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
SelectorSettings (dict) -- The video selector settings.
VideoSelectorPid (dict) -- Video Selector Pid
Pid (integer) -- Selects a specific PID from within a video source.
VideoSelectorProgramId (dict) -- Video Selector Program Id
ProgramId (integer) -- Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
InputSpecification (dict) -- Placeholder documentation for InputSpecification
Codec (string) -- Input codec
MaximumBitrate (string) -- Maximum input bitrate, categorized coarsely
Resolution (string) -- Input resolution, categorized coarsely
LogLevel (string) -- The log level being written to CloudWatch Logs.
Name (string) -- The name of the channel. (user-mutable)
PipelineDetails (list) -- Runtime details for the pipelines of a running channel.
(dict) -- Runtime details of a pipeline when a channel is running.
ActiveInputAttachmentName (string) -- The name of the active input attachment currently being ingested by this pipeline.
ActiveInputSwitchActionName (string) -- The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
PipelineId (string) -- Pipeline ID
PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
RoleArn (string) -- The Amazon Resource Name (ARN) of the role assumed when running the Channel.
State (string) -- Placeholder documentation for ChannelState
Tags (dict) -- A collection of key-value pairs.
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
{'Reservation': {'ResourceSpecification': {'Resolution': ['FHD'],
'ResourceType': ['MULTIPLEX']}}}
Update reservation.
See also: AWS API Documentation
Request Syntax
client.update_reservation(
Name='string',
ReservationId='string'
)
string
Name of the reservation
string
[REQUIRED] Unique reservation ID, e.g. '1234567'
dict
Response Syntax
{
'Reservation': {
'Arn': 'string',
'Count': 123,
'CurrencyCode': 'string',
'Duration': 123,
'DurationUnits': 'MONTHS',
'End': 'string',
'FixedPrice': 123.0,
'Name': 'string',
'OfferingDescription': 'string',
'OfferingId': 'string',
'OfferingType': 'NO_UPFRONT',
'Region': 'string',
'ReservationId': 'string',
'ResourceSpecification': {
'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO',
'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
'Resolution': 'SD'|'HD'|'FHD'|'UHD',
'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
},
'Start': 'string',
'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
'Tags': {
'string': 'string'
},
'UsagePrice': 123.0
}
}
Response Structure
(dict) -- Updated reservation
Reservation (dict) -- Reserved resources available to use
Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
Count (integer) -- Number of reserved resources
CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
Duration (integer) -- Lease duration, e.g. '12'
DurationUnits (string) -- Units for duration, e.g. 'MONTHS'
End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
Name (string) -- User specified reservation name
OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
OfferingId (string) -- Unique offering ID, e.g. '87654321'
OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'
Region (string) -- AWS region, e.g. 'us-west-2'
ReservationId (string) -- Unique reservation ID, e.g. '1234567'
ResourceSpecification (dict) -- Resource configuration details
ChannelClass (string) -- Channel class, e.g. 'STANDARD'
Codec (string) -- Codec, e.g. 'AVC'
MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'
MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
Resolution (string) -- Resolution, e.g. 'HD'
ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)
Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
State (string) -- Current state of reservation, e.g. 'ACTIVE'
Tags (dict) -- A collection of key-value pairs
(string) -- Placeholder documentation for __string
(string) -- Placeholder documentation for __string
UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'