FlowBodySpec
object
List of flow inputs.
Read Flow inputs and outputs to learn more about how to connect flow inputs between content and flow transform inputs.
Show 5 propertiesHide 5 properties
contentNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The <glossary:content> that the flow input is connected to. This also influences the content that will be available on the flow outputs.
Read Resolving content to learn more about how content is resolved to the <glossary:source>s and <glossary:flow>s that can supply it.
flowNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The upstream <glossary:flow> that the flow input is connected to. This also influences the content that will be available on the flow outputs.
The <glossary:refiners> that influence how this flow input will be assigned and how content will be resolved for it. For example, flow inputs can be constrained to specific upstream <glossary:flow>s and <glossary:source>s. To learn more, read Flow input refiners.
Show 2 propertiesHide 2 properties
Refiner to restrict a flow's input to originate from a specific flow.
Show 1 propertyHide 1 property
namestringRequired
Name of the resource to match.
Refiner to restrict a flow's input to originate from one of a set of both flows and content sources.
Show 2 propertiesHide 2 properties
keystringRequired
Name of the label to match against. Case sensitive.
valuestringRequired
The desired value of the label. Case sensitive.
sourceNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The <glossary:source> that the flow input is connected to. This also influences the content that will be available on the flow outputs.
transformInputstringOptional1-128 characters
The name of the input pin to connect in the associated processing config. Retrieve the config through the Templates API and use a name from
status.inputPins[].name.List of flow outputs.
Read Flow inputs and outputs to learn more about how to connect flow outputs between flow transform outputs and destinations or to make them available to other flows.
Show 5 propertiesHide 5 properties
contentNamestringOptional
Optional, sets the <glossary:content> that is provided by this flow output.
destinationNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The destination to connect the flow output to. Omit this field to create an <<glossary:internal flow output>>.
Read Flows to learn more about how to connect flows to other flows.
The <glossary:refiners> that influence how this flow output will be assigned. This is a placeholder for future functionality.
transformOutputstringOptional1-128 characters
The name of the output pin to connect in the associated processing config. Retrieve the config through the Templates API and use a name from
status.outputPins[].name.Transport setting overrides for this specific flow output. If not specified, the transport will use the default settings.
Show 1 propertyHide 1 property
maxConnectionsintegerOptional>=1
Optional, specifies the maximum number of connections for this output if no destination is specified.
The <glossary:refiners> that influence how this flow will be assigned. This is a placeholder for future functionality.
siteNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The name of the <glossary:site> where the flow will run. If omitted, the site is inferred from the flow type: cloud flows default to the project's cloud site; device flows default to the 'world' site.
stateenumRequired
The desired state of the flow.
Allowed values:StoppedRunning
transformobjectRequired
Configuration for the transformation that this flow performs
Show 4 variantsHide 4 variants
Discriminated by type. Select one variant:
LiveChannelobjectLiveChannelFlow
A 24x7 flow that takes live input and encodes it, storing the material in the asset named by the required assetName field.
Starting a LiveChannel flow will immediately charge the full monthly fee to your payment method, no matter how much of the month remains.
Please see LiveEvent for encoding billed by the minute.
archiveWindowLengthstringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.
assetNamestringRequired
The name of asset that you want this flow to store material in.
assetPathstringOptional
If an asset name is given, then you may also specify a subpath within the asset for the material.
Reference to template of type 'encodingLive'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'streamConditioning'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
typestringRequired
Processing type.
LiveEventobjectLiveEventFlow
A flow that takes live input and encodes it, storing the material in the asset named by the required assetName field.
A LiveEvent flow is billed by the minute, please see LiveChannel for encoding billed by the month.
archiveWindowLengthstringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.
assetNamestringRequired
The name of asset that you want this flow to store material in.
assetPathstringOptional
If an asset name is given, then you may also specify a subpath within the asset for the material.
Reference to template of type 'encodingLive'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'streamConditioning'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
typestringRequired
Processing type.
StaticMultiviewChannelobjectStaticMultiviewChannelFlow
A 24x7 flow that takes multiple live inputs, composes and encodes them, storing the material in the asset named by the required assetName field.
Supports two modes:
- With multiviewComposing: Inputs defined in multiviewComposing config.
- Without multiviewComposing: Inputs defined in encodingLive config using multiInputComposer input type.
Starting a StaticMultiviewChannel flow will immediately charge the full monthly fee to your payment method, no matter how much of the month remains.
Please see StaticMultiviewEvent for encoding billed by the minute.
archiveWindowLengthstringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.
assetNamestringRequired
The name of asset that you want this flow to store material in.
assetPathstringOptional
If an asset name is given, then you may also specify a subpath within the asset for the material.
Reference to template of type 'encodingLive'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'multiviewComposing'. If omitted, inputs are taken from encodingLive.
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'streamConditioning'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
typestringRequired
Processing type.
StaticMultiviewEventobjectStaticMultiviewEventFlow
A flow that takes multiple live inputs, composes and encodes them, storing the material in the asset named by the required assetName field.
Supports two modes:
- With multiviewComposing: Inputs defined in multiviewComposing config.
- Without multiviewComposing: Inputs defined in encodingLive config using multiInputComposer input type.
A StaticMultiviewEvent flow is billed by the minute, please see StaticMultiviewChannel for encoding billed by the month.
archiveWindowLengthstringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.
assetNamestringRequired
The name of asset that you want this flow to store material in.
assetPathstringOptional
If an asset name is given, then you may also specify a subpath within the asset for the material.
Reference to template of type 'encodingLive'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'multiviewComposing'. If omitted, inputs are taken from encodingLive.
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'streamConditioning'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
typestringRequired
Processing type.