# JSON payload for create actions
The following sections show the structure of the payload and an example of the payload for every type of create action for a MediaLive schedule.
**Topics**
+ [Input switch action – payload](cli-schedule-fields-for-input-switch.md)
+ [Input prepare action – payload](cli-schedule-fields-for-input-prep.md)
+ [Activate global image action – payload](cli-schedule-fields-for-activate-image.md)
+ [Deactivate global overlay action – payload](cli-schedule-fields-for-deactivate-image.md)
+ [Activate per-outputs image action – payload](cli-schedule-fields-for-activate-image-per-output.md)
+ [Deactivate per-outputs overlay action – payload](cli-schedule-fields-for-deactivate-image-per-output.md)
+ [Activate motion graphic overlay – payload](cli-schedule-fields-activate-mgi.md)
+ [Deactivate motion graphic overlay – payload](cli-schedule-fields-deactivate-mgi.md)
+ [Splice\$1insert message – payload](cli-schedule-fields-for-splice-insert.md)
+ [Time\$1signal message – payload](cli-schedule-fields-for-time-signal.md)
+ [Return-to-network message – payload](cli-schedule-fields-for-return-network.md)
+ [ID3 metadata item – payload](cli-schedule-fields-for-id3.md)
+ [ID3 segment tag item – payload](cli-schedule-fields-id3-segment-tag.md)
+ [Pause pipeline action – payload](cli-schedule-fields-for-pause.md)
+ [Combination of create actions](cli-example-multiple-creates.md)
# Input switch action – payload
The following sections show the payload for input switch actions.
In this payload, the `ScheduleActionStartSettings` contains only one of `FixedModeScheduleActionStartSettings`, `ImmediateModeScheduleActionStartSettings`, or `FollowModeScheduleActionStartSettings`.
See the examples that follow for samples of each of these tags.
For information about the meaning and values for the fields in the following JSON, see [Fields for an input switch](schedule-fields-for-ips.md).
```
{
"ChannelId": "string",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"FollowModeScheduleActionStartSettings": {
"FollowPoint": "enum",
"ReferenceActionName": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"InputSwitchSettings": {
"InputAttachmentNameReference": "string",
"InputClippingSettings": {
"InputTimecodeSource": "enum",
"StartTimecode": {
"Timecode": "string"
},
"StopTimecode": {
"LastFrameClippingBehavior": "enum",
"Timecode": "string"
}
},
"UrlPath": ["string", ...]
}
}
]
}
}
```
## Example of a switch to a live input with fixed start time
This example of a request is to switch to a live input at a fixed start time. The switch action is called `studio-feed` and it switches to the input that is connected to the input attachment called `live-studio-feed`. It switches to this input at the specified UTC time.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:19.000Z"
}
},
"ActionName": "studio-feed",
"ScheduleActionSettings": {
"InputSwitchSettings": {
"InputAttachmentNameReference": "live-studio-feed"
}
}
}
]
}
}
```
## Example of a static file switch as a follow
This example of a request is to switch to a static file input to follow the end of the previous input. The switch action is called `action-ad-003` and it switches to the input that is connected to the input attachment called `zel-cafe`. It switches to this input when the action called `action-ad-002` ends. The file for this action is clipped so that it ends after 30 seconds and 11 frames:
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FollowModeScheduleActionStartSettings": {
"FollowPoint": "END",
"ReferenceActionName": "action-ad-002"
}
},
"ActionName": "action-ad-003",
"ScheduleActionSettings": {
"InputSwitchSettings": {
"InputAttachmentNameReference": "zel-cafe",
"InputClippingSettings": {
"InputTimecodeSource": "ZEROBASED",
"StopTimecode":{
"Timecode": "00:00:30:11",
"LastFrameClippingBehavior": "INCLUDE_LAST_FRAME"
}
}
}
}
}
]
}
}
```
## Example of a switch to a dynamic input with immediate start time
This example of a request is to switch to a dynamic file input immediately. The switch action is called `action-unscheduled-standby` and it switches to the input that is connected to the input attachment called `dynamic-unscheduled-standby`. For this usage of the dynamic input, the files to use are `oceanwaves.mp4`.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings":
{
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "action-unscheduled-slate",
"ScheduleActionSettings": {
"InputSwitchSettings": {
"InputAttachmentNameReference": "slate",
"UrlPath":[
"main/oceanwaves.mp4",
"redundant/oceanwaves.mp4"]
}
}
}
]
}
}
```
# Input prepare action – payload
The following sections show the payload for input switch actions.
In this payload, the `ScheduleActionStartSettings` contains only one of `FixedModeScheduleActionStartSettings`, `ImmediateModeScheduleActionStartSettings`, or `FollowModeScheduleActionStartSettings`.
See the examples that follow for samples of each of these tags.
For information about the meaning and values for the fields in the following JSON, see [Fields for an input switch](schedule-fields-for-ips.md).
```
{
"ChannelId": "string",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"FollowModeScheduleActionStartSettings": {
"FollowPoint": "enum",
"ReferenceActionName": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"InputPrepareSettings": {
"InputAttachmentNameReference": "string",
"InputClippingSettings": {
"InputTimecodeSource": "enum",
"StartTimecode": {
"Timecode": "string"
},
"StopTimecode": {
"LastFrameClippingBehavior": "enum",
"Timecode": "string"
}
},
"UrlPath": ["string", ...]
}
}
}
]
}
}
```
## Example of an input prepare with a fixed start time
This example of a request is to switch to a live input at a fixed start time. The switch action is called `studio-feed` and it switches to the input that is connected to the input attachment called `live-studio-feed`. It switches to this input at the specified UTC time.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:19.000Z"
}
},
"ActionName": "studio-feed",
"ScheduleActionSettings": {
"InputSwitchSettings": {
"InputAttachmentNameReference": "live-studio-feed"
}
}
}
]
}
}
```
## Example of an input prepare as a follow
This example of a request is to switch to a static file input to follow the end of the previous input. The switch action is called `action-ad-003` and it switches to the input that is connected to the input attachment called `zel-cafe`. It switches to this input when the action called `action-ad-002` ends. The file for this action is clipped so that it ends after 30 seconds and 11 frames:
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FollowModeScheduleActionStartSettings": {
"FollowPoint": "END",
"ReferenceActionName": "action-ad-002"
}
},
"ActionName": "action-ad-003",
"ScheduleActionSettings": {
"InputSwitchSettings": {
"InputAttachmentNameReference": "zel-cafe",
"InputClippingSettings": {
"InputTimecodeSource": "ZEROBASED",
"StopTimecode":{
"Timecode": "00:00:30:11",
"LastFrameClippingBehavior": "INCLUDE_LAST_FRAME"
}
}
}
}
}
]
}
}
```
# Activate global image action – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for activating a global image overlay](schedule-fields-for-activate-image.md).
```
{
"ChannelId": "string",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"StaticImageActivateSettings": {
"Duration": integer,
"FadeIn": integer,
"FadeOut": integer,
"Height": integer,
"Image": {
"PasswordParam": "string",
"Uri": "string",
"Username": "string"
},
"ImageX": integer,
"ImageY": integer,
"Layer": integer,
"Opacity": integer,
"Width": integer
}
}
}
]
}
}
```
## Example
This example of a request creates an image overlay to be inserted in every video output in every output group in the channel. The overlay uses a file that is stored in an Amazon S3 bucket. The request doesn't include a duration and therefore doesn't include a fadeout. Instead, the intention is to send a separate deactivate request at the appropriate time. All the times are in milliseconds, and all the positioning values are in pixels:
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:19.000Z"
}
},
"ActionName": "corporate-logo-030",
"ScheduleActionSettings": {
"StaticImageActivateSettings": {
"Image": {
"PasswordParam": "corplogo!2312",
"Uri": "s3ssl://amzn-s3-demo-bucket/logos/corporate/high-res.bmp",
"Username": "medialiveoperator"
},
"Layer": 1,
"FadeIn": 1500,
"Height": 900
"Width": 800,
"ImageX": 200,
"ImageY": 300,
"Opacity": 60,
}
}
}
]
}
}
```
# Deactivate global overlay action – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for deactivating a global image overlay](schedule-fields-for-deactivate-image.md).
```
{
"ChannelId": "string",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"StaticImageDeactivateSettings": {
"FadeOut": integer,
"Layer": integer
}
}
}
]
}
```
## Example
This example of a request creates an action to remove an image overlay at 20:42:04.000 (UTC) with a 500-millisecond fadeout that is added onto the end time, which means that the overlay will be invisible at 20:42:04.500.
The action removes the images overlay that is in the global layer 4. This means it removes the image *only if* it was inserted using the global action (StaticImageActivateSettings). It doesn't remove the overlay from the per-outputs layer 4.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:04.000Z"
}
},
"ActionName": "stop-overlay-029",
"ScheduleActionSettings": {
"StaticImageDeactivateSettings": {
"FadeOut": 500,
"Layer": 4
}
}
}
]
}
}
```
# Activate per-outputs image action – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for activating a per-outputs image overlay](schedule-fields-activate-image-per-output.md).
```
{
"ChannelId": "string",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"StaticImageOutputActivateSettings": {
"Duration": integer,
"FadeIn": integer,
"FadeOut": integer,
"Height": integer,
"Image": {
"PasswordParam": "string",
"Uri": "string",
"Username": "string"
},
"ImageX": integer,
"ImageY": integer,
"Layer": integer,
"Opacity": integer,
"OutputNames": [
{}
],
"Width": integer
}
}
}
]
}
}
```
## Example
This example of a request creates an image overlay to be inserted in specific outputs in the channel. The overlay uses a file that is stored in an Amazon S3 bucket. The request inserts the image in the outputs `hls-high-res` and `mss-high-res`. The image is sized appropriately for the video resolution in these outputs.
The request is intended to be always present. Therefore, it is set up to start immediately (as soon as the channel starts). All the times are in milliseconds, and all the positioning values are in pixels:
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings":
{
"ImmediateModeScheduleActionStartSettings": {
}
},
},
"ActionName": "logo-1280",
"ScheduleActionSettings": {
"StaticImageOutputActivateSettings": {
"Image": {
"PasswordParam": "corplogo!2312",
"Uri": "s3ssl://amzn-s3-demo-bucket/logos/corporate/10percent-1280.bmp",
"Username": "medialiveoperator"
},
"Layer": 0,
"outputNames": [
hls-high-res,mss-high-res
],
"ImageX": 200,
"ImageY": 300,
"FadeIn": 1500,
"Opacity": 60
}
}
}
]
}
}
```
# Deactivate per-outputs overlay action – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for deactivating a per-outputs image overlay](schedule-fields-deactivate-image-per-output.md).
```
{
"ChannelId": "string",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"StaticImageOutputDeactivateSettings": {
"FadeOut": integer,
"Layer": integer,
"OutputNames"
}
}
}
]
}
```
## Example
The deactivate action deactivates the image in the specified per-output layer, in the specified output or outputs.
In this example, which follows on from the activate example, the action removes all image overlays that are in per-outputs layer 4 in the output hls-high-res.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:04.000Z"
}
},
"ActionName": "stop-layer4-all-outputs",
"ScheduleActionSettings": {
"StaticImageOutputDeactivateSettings": {
"outputNames": [
hls-high-res
],
"FadeOut": 500,
"Layer": 4
}
}
}
]
}
}
```
# Activate motion graphic overlay – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for activating a motion graphics overlay](schedule-fields-for-mg.md).
```
{
"ChannelId": "string",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"MotionGraphicsImageActivateSettings": {
"Duration": integer
"Url": "string"
"Username": "string",
"PasswordParam": "string"
}
}
]
}
}
```
## Example
This example of a request creates a motion graphics overlay action called mg\$1ticker\$1tape. The motion graphic asset is stored at http://example.com/ticker\$1tape.html. This server requires user credentials. The request doesn't include a duration. Instead, the intention is to send a separate deactivate request at the appropriate time.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:04.000Z"
}
},
"ActionName": "mg_ticker_tape",
"ScheduleActionSettings": {
"MotionGraphicsImageActivateSettings": {
"Url": "https://example.com/ticker_tape.html"
"Username": "medialiveoperator",
"PasswordParam": "/medialive/12345"
}
}
]
}
}
```
# Deactivate motion graphic overlay – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for deactivating a motion graphics overlay](schedule-fields-for-mg-deactivate.md).
```
{
"ChannelId": "string",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"MotionGraphicsImageDeactivateSettings": {
}
}
}
]
}
}
```
## Example
This example of a request creates an action to end a motion graphic overlay at 23:59:00.000 (UTC). :
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T23:59:00.000Z"
},
"ActionName": "deactivate-ticker-tape",
"ScheduleActionSettings": {
"MotionGraphicsImageDeactivateSettings": {
}
}
}
]
}
}
```
# Splice\$1insert message – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for a splice\$1insert message](schedule-fields-for-splice_insert.md).
```
{
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"FollowModeScheduleActionStartSettings": {
"FollowPoint": "enum",
"ReferenceActionName": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"Scte35SpliceInsertSettings": {
"Duration": integer,
"SpliceEventId": integer
}
}
}
]
}
```
## Example of a splice insert with a fixed start time
This example of a request creates an action for a splice\$1insert with a UTC start time of 20:42:04.000. It also has an `ActionName` that perhaps references an ad avail from your database, a unique integer for the splice event ID, and a duration of 1,350,000 kHz ticks (15 seconds).
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:04.000Z"
}
},
"ActionName": "adavail-3708",
"ScheduleActionSettings": {
"Scte35SpliceInsertSettings": {
"SpliceEventId": 3708,
"Duration": 1350000
}
}
}
]
}
}
```
## Example of a splice insert as a follow
This example of a request creates an action for a splice\$1insert to be inserted after the input switch called nature-doco-003 ends. The action has an `ActionName` that perhaps references an ad avail from your database, a unique integer for the splice event ID, and a duration of 1,350,000 kHz ticks (15 seconds).
Follow mode for a SCTE 35 message is useful when you want an ad avail to occur as soon as an input finishes, but you don't know when that will happen.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FollowModeScheduleActionStartSettings": {
"FollowPoint": "END",
"ReferenceActionName": "nature-doco-003"
}
},
"ActionName": "adavail-3708",
"ScheduleActionSettings": {
"Scte35SpliceInsertSettings": {
"SpliceEventId": 3708,
"Duration": 1350000
}
}
}
]
}
}
```
# Time\$1signal message – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for a time\$1signal message](schedule-fields-for-time-signal.md).
```
{
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"FollowModeScheduleActionStartSettings": {
"FollowPoint": "enum",
"ReferenceActionName": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"Scte35TimeSignalSettings": {
"Scte35Descriptors": [
{
"Scte35DescriptorSettings": {
"SegmentationDescriptorScte35DescriptorSettings": {
"DeliveryRestrictions": {
"ArchiveAllowedFlag": "enum",
"DeviceRestrictions": "enum",
"NoRegionalBlackoutFlag": "enum",
"WebDeliveryAllowedFlag": "enum"
},
"SegmentNum": integer,
"SegmentationCancelIndicator": "enum",
"SegmentationDuration": integer,
"SegmentationEventId": integer,
"SegmentationTypeId": integer,
"SegmentationUpid": "string",
"SegmentationUpidType": integer,
"SegmentsExpected": integer,
"SubSegmentNum": integer,
"SubSegmentsExpected": integer
}
}
}
]
}
}
}
]
}
```
## Example
This example of a request creates an action for a time\$1signal with a UTC start time of 20:42:04.000 and with a unique integer for `SegmentationEventId`. For the restrictions fields, `NoRegionalBlackoutFlag` has a restriction set (regional blackouts are in place).
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:04.000Z"
}
},
"ActionName": "adavail-3708",
"ScheduleActionSettings": {
"Scte35TimeSignalSettings": {
"Scte35Descriptors": [
{
"Scte35DescriptorSettings": {
"SegmentationDescriptorScte35DescriptorSettings": {
"SubSegmentsExpected": 0,
"SegmentationEventId": 7054,
"SegmentationDuration": 1350000,
"SegmentationCancelIndicator": 0,
"SubSegmentNum": 0,
"SegmentationUpidType": 12,
"SegmentNum": 0,
"SegmentationCancelIndicator": "SEGMENTATION_EVENT_NOT_CANCELED",
"DeliveryRestrictions": {
"DeviceRestrictions": "NONE",
"WebDeliveryAllowedFlag": "WEB_DELIVERY_ALLOWED",
"NoRegionalBlackoutFlag": "REGIONAL_BLACKOUT",
"ArchiveAllowedFlag": "ARCHIVE_ALLOWED"
},
"SegmentationUpid": "4a414e3136494e4155303031",
"SegmentationTypeId": 52,
"SegmentsExpected": 0
}
}
}
]
}
}
}
]
}
}
```
# Return-to-network message – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for a return-to-network message](schedule-fields-for-return-to-network.md).
```
{
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"FollowModeScheduleActionStartSettings": {
"FollowPoint": "enum",
"ReferenceActionName": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"Scte35ReturnToNetworkSettings": {
"SpliceEventId": integer
}
}
}
]
}
```
## Example
This example of a request creates a return-to-network with a UTC start time of 20:42:19.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:19.000Z"
}
},
"ActionName": "end-adavail-3708",
"ScheduleActionSettings": {
"Scte35ReturnToNetworkSettings": {
}
}
}
]
}
}
```
# ID3 metadata item – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for ID3 metadata](schedule-fields-for-id3-userdata.md).
**Payload for the HlsTimedMetadataSettings action**
```
{
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"HlsTimedMetadataSettings": {
"Id3": "string"
}
}
}
]
}
```
**Payload for the TimedMetadataSettings action**
```
{
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"TimedMetadataSettings": {
"Id3": "string"
}
}
}
]
}
```
## Example
This example of a request uses the `HlsTimedMetadataSettings` action. It creates ID3 metadata to be inserted in a appropriate output groups at 13:35:59 UTC.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2019-01-02T13:35:59Z"
}
},
"ActionName": "id3-metadata.2019-01-02T13:35:59Z",
"ScheduleActionSettings": {
"HlsTimedMetadataSettings": {
"Id3": "SUQzBAAAAAAAF1RJVDIAAAANAAADSGVsbG8gV29ybGQA"
}
}
}
]
}
}
```
# ID3 segment tag item – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for ID3 segment tags](schedule-fields-for-id3-segment-tags.md).
**Payload for the HlsId3SegmentTaggingSettings action**
```
{
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"HlsId3SegmentTaggingSettings": {
"Tag": "string"
"Id3": "string"
}
}
}
]
}
```
**Payload for the Id3SegmentTaggingSettings action**
```
{
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"Id3SegmentTaggingSettings": {
"Tag": "string"
"Id3": "string"
}
}
}
]
}
```
## Example using the tag property
This example of a request uses the `HlsId3SegmentTaggingSettings` action. It creates an ID3 segment tag to be inserted starting at 13:35:59 UTC. This example uses the `Tag` property , which means that you specify only the content of the `value` for the `TXXX` field. In this example, the content is the date, time, and number of the segment.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2020-01-02T13:35:59Z"
}
},
"ActionName": "id3-datetime-and-segment",
"ScheduleActionSettings": {
"HlsId3SegmentTaggingSettings": {
"Tag": "$dt$-$sn$"
}
}
}
]
}
}
```
## Example using the Id3 property
This example of a request creates an ID3 segment tag to be inserted immediately. This example uses the `Id3` property, which means that the content is encoded as base64.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
ImmediateModeScheduleActionStartSettings
}
},
"ActionName": "id3-song309",
"ScheduleActionSettings": {
"HlsId3SegmentTaggingSettings": {
"Id3": "SUQzBAAAAAAAF1RJVDIAAAANAAADSGVsbG8gV29ybGQA"
}
}
}
]
}
}
```
# Pause pipeline action – payload
For information about the meaning and values for the fields in the following JSON, see [Fields for pause](schedule-fields-for-pause.md).
```
{
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "string"
},
"ImmediateModeScheduleActionStartSettings": {
}
},
"ActionName": "string",
"ScheduleActionSettings": {
"PauseStateSettings": {
"Pipelines": [
{
"PipelineId": "enum"
}
]
}
}
}
]
}
```
## Example: Pausing one pipeline
This example of a request pauses pipeline 0 at 20:42:19 UTC. MediaLive always reads the command as:*set the specified pipeline or pipelines to pause and set all other pipelines to unpaused.*
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-05-21T20:42:19Z"
}
},
"ActionName": "pause-pipeline-0-now",
"ScheduleActionSettings": {
"PauseStateSettings": {
"Pipelines": [
{
"PipelineId": "PIPELINE_0"
}
]
}
}
}
]
}
}
```
## Example: Unpausing both pipelines
This example of a request unpauses all pipelines that are currently paused.
**Note**
MediaLive always reads the command as:*set the specified pipeline or pipelines to pause and set all other pipelines to unpaused.* In this example, the `Pipelines` array is empty. MediaLive interprets this empty array as: *set all pipelines to unpaused*.
```
{
"ChannelId": "999999",
"Creates": {
"ScheduleActions": [
{
"ScheduleActionStartSettings": {
"ImmediateModeScheduleActionStartSettings": {}
},
"ActionName": "unpause-pipeline-0",
"ScheduleActionSettings": {
"PauseStateSettings": {
"Pipelines": [
{}
]
}
}
}
]
}
}
```
# Combination of create actions
Here is an example of a JSON body to pass into the `--creates` parameter of the `batch-update-schedule` AWS CLI command. It contains two actions to create. In this example, both actions are splice\$1inserts, but in fact you can combine any number and any type of create actions.
```
{
"ScheduleActions": [
{
"ScheduleActionSettings": {
"Scte35SpliceInsertSettings": {
"Duration": 1350000,
"SpliceEventId": 3
}
},
"ActionName": "SpliceInsert-01",
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-11-05T16:10:30.000Z"
}
}
},
{
"ScheduleActionSettings": {
"Scte35SpliceInsertSettings": {
"Duration": 2700000,
"SpliceEventId": 3
}
},
"ActionName": "SpliceInsert-02",
"ScheduleActionStartSettings": {
"FixedModeScheduleActionStartSettings": {
"Time": "2018-11-05T16:30:45.000Z"
}
}
}
]
}
```