Mux
App · 20 actions
Manage video assets, direct uploads, live streams and playback IDs in Mux.
Actions
| Action | What it does |
|---|---|
| Add asset text track | Adds an asset track (for example, subtitles, or an alternate audio track) to an asset. |
| Create asset | Create a new Mux Video asset. |
| Create asset playback ID | Creates a playback ID that can be used to stream the asset to a viewer. |
| Create direct upload | Creates a new direct upload, through which video content can be uploaded for ingest to Mux. |
| Create live stream | Creates a new live stream. |
| Delete asset | Deletes a video asset and all its data. |
| Delete asset playback ID | Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. |
| Delete asset track | Removes a text or additional audio track from an asset. |
| Delete live stream | Deletes a live stream from the current environment. |
| Disable live stream | Disables a live stream, making it reject incoming RTMP streams until re-enabled. |
| Enable live stream | Enables a live stream, allowing it to accept an incoming RTMP stream. |
| Get asset | Retrieves the details of an asset that has previously been created. |
| Get direct upload | Fetches information about a single direct upload in the current environment. |
| Get live stream | Retrieves the details of a live stream that has previously been created. |
| Get resource by playback ID | Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID. |
| List assets | List all Mux assets. |
| List direct uploads | Lists direct uploads in the current environment. |
| List live streams | Lists the live streams that currently exist in the current environment. |
| Update asset | Updates the details of an existing Asset with the provided Asset ID. |
| Update live stream | Updates the parameters of a previously-created live stream. |
Add asset text track
Adds an asset track (for example, subtitles, or an alternate audio track) to an asset. Assets must be in the ready state before tracks can be added.
Inputs
- Asset
asset_idtextRequired - The asset ID.
- URL
urltextRequired - The URL of the file that Mux should download and use. * For audio tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should use standard…
- Text type
text_typetext - The type of text track. Required when type is text. Use subtitles for subtitles and closed captions, or chapters for a chapters track.One of:
subtitles,chapters. - Language code
language_codetextRequired - The language code of this track. The value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English.
- Name
nametext - The name of the track containing a human-readable description. This value must be unique within each group of text or audio track types. The HLS manifest will associate the text or audio track with this value. For example, set the value to "English" for subtitles text track…
- Closed captions
closed_captionstrue/false - Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
- Passthrough
passthroughtext - Arbitrary user-supplied metadata set for the track either when creating the asset or track.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"auto_language_confidence": 1.0,
"closed_captions": false,
"duration": 1.0,
"id": "example",
"language_code": "example",
"max_channels": 1,
"max_frame_rate": 1.0,
"max_height": 1,
"max_width": 1,
"name": "example",
"passthrough": "example",
"primary": false,
"status": "example",
"text_source": "example",
"text_type": "example",
"type": "example"
}
}
}Create asset
Create a new Mux Video asset.
Inputs
- Video URL
video_urltext - Publicly accessible URL of the source video or audio.
- Inputs
inputslist - An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See input[].url for requirements.
- Playback policies
playback_policieslist - An array of playback policy names that you want applied to this asset and available through playback_ids. Options include:One or more of:
public,signed,drm. - Advanced playback policies
advanced_playback_policieslist - An array of playback policy objects that you want applied to this asset and available through playback_ids. advanced_playback_policies must be used instead of playback_policies when creating a DRM playback ID.
- Passthrough
passthroughtext - You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as title or external_id, you can use the meta object instead. Max: 255 characters.
- Mp4 support
mp4_supporttext - Deprecated. See the Static Renditions API for the updated API.One of:
none,standard,capped-1080p,audio-only,audio-only,capped-1080p. - Normalize audio
normalize_audiotrue/false - Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.Default:
false. - Master access
master_accesstext - Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the Download your videos guide for more information.One of:
none,temporary. - Test
testtrue/false - Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after…
- Max resolution tier
max_resolution_tiertext - Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.One of:
1080p,1440p,2160p. - Video quality
video_qualitytext - The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated encoding_tier value. See the video quality guide for more details.One of:
basic,plus,premium. - Static renditions
static_renditionslist - An array of static renditions to create for this asset. You may not enable both static_renditions and the deprecated mp4_support.
- Meta
metaobject - Customer provided metadata about this asset.
- Copy overlays
copy_overlaystrue/false - If the created asset is a clip, this controls whether overlays are copied from the source asset.Default:
true. - Directives
directiveslist - An array of Mux Robots directives to apply to the asset.
- Generate shots
generate_shotstrue/false - Whether to perform shot detection on this asset. Shots are only generated for video assets and will not be generated for audio-only assets.Default:
false.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"aspect_ratio": "example",
"created_at": "example",
"directives": [],
"duration": 1.0,
"encoding_tier": "example",
"errors": {
"messages": [],
"type": "example"
},
"generate_shots": false,
"id": "example",
"ingest_type": "example",
"is_live": false,
"live_stream_id": "example",
"master": {
"status": "example",
"url": "example"
},
"master_access": "example",
"max_resolution_tier": "example",
"max_stored_frame_rate": 1.0,
"max_stored_resolution": "example",
"meta": {
"creator_id": "example",
"external_id": "example",
"title": "example"
},
"mp4_support": "example",
"non_standard_input_reasons": {
"audio_codec": "example",
"audio_edit_list": "example",
"pixel_aspect_ratio": "example",
"unexpected_media_file_parameters": "example",
"unsupported_pixel_format": "example",
"video_bitrate": "example",
"video_codec": "example",
"video_edit_list": "example",
"video_frame_rate": "example",
"video_gop_size": "example",
"video_resolution": "example"
},
"normalize_audio": false,
"passthrough": "example",
"playback_ids": [],
"progress": {
"progress": 1.0,
"state": "example"
},
"recording_times": [],
"resolution_tier": "example",
"shots": {
"created_at": "example",
"errors": {
"messages": [],
"type": "example"
},
"shots_manifest_url": "example",
"status": "example"
},
"source_asset_id": "example",
"static_renditions": {
"files": [],
"status": "example"
},
"status": "example",
"test": false,
"thumbnail_time": 1.0,
"tracks": [],
"upload_id": "example",
"video_quality": "example"
}
}
}Create asset playback ID
Creates a playback ID that can be used to stream the asset to a viewer.
Inputs
- Asset
asset_idtextRequired - The asset ID.
- Policy
policytext - * public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}One of:
public,signed,drm. - Drm configuration ID
drm_configuration_idtext - The DRM configuration used by this playback ID. Must only be set when policy is set to drm.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"drm_configuration_id": "example",
"id": "example",
"policy": "example"
}
}
}Create direct upload
Creates a new direct upload, through which video content can be uploaded for ingest to Mux.
Inputs
- Timeout
timeoutnumber - Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked timed_outFrom 60 to 604800. Default:
3600. - Cors origin
cors_origintextRequired - If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers.
- New asset settings
new_asset_settingsobject - New asset settings.
- Test
testtrue/false - Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a test Asset.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"asset_id": "example",
"cors_origin": "example",
"error": {
"message": "example",
"type": "example"
},
"id": "example",
"new_asset_settings": {
"advanced_playback_policies": [],
"copy_overlays": false,
"directives": [],
"encoding_tier": "example",
"generate_shots": false,
"input": [],
"inputs": [],
"master_access": "example",
"max_resolution_tier": "example",
"meta": {
"creator_id": "example",
"external_id": "example",
"title": "example"
},
"mp4_support": "example",
"normalize_audio": false,
"passthrough": "example",
"playback_policies": [],
"playback_policy": [],
"static_renditions": [],
"test": false,
"video_quality": "example"
},
"status": "example",
"test": false,
"timeout": 1,
"url": "example"
}
}
}Create live stream
Creates a new live stream. Once created, an encoder can connect to Mux via the specified stream key and begin streaming to an audience.
Inputs
- Playback policy
playback_policylist - Deprecated. Use playback_policies instead, which accepts an identical type.One or more of:
public,signed,drm. - Playback policies
playback_policieslist - An array of playback policy names that you want applied to this live stream and available through playback_ids. Options include:One or more of:
public,signed,drm. - Advanced playback policies
advanced_playback_policieslist - An array of playback policy objects that you want applied on this live stream and available through playback_ids. advanced_playback_policies must be used instead of playback_policies when creating a DRM playback ID.
- New asset settings
new_asset_settingsobject - New asset settings.
- Reconnect window
reconnect_windownumber - When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the…From 0 to 1800. Default:
60. - Use slate for standard latency
use_slate_for_standard_latencytrue/false - By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream.Default:
false. - Reconnect slate URL
reconnect_slate_urltext - The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used.
- Passthrough
passthroughtext - Passthrough.
- Audio only
audio_onlytrue/false - Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted.
- Embedded subtitles
embedded_subtitleslist - Describe the embedded closed caption contents of the incoming live stream.
- Generated subtitles
generated_subtitleslist - Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with generated_subtitles configured will automatically receive two text tracks. The first of these will have a text_source value of…
- Reduced latency
reduced_latencytrue/false - This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Read more here:…
- Low latency
low_latencytrue/false - This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This…
- Latency mode
latency_modetext - Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags.One of:
low,reduced,standard. - Test
testtrue/false - Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and…
- Simulcast targets
simulcast_targetslist - Simulcast targets.
- Max continuous duration
max_continuous_durationnumber - The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.From 60 to 43200. Default:
43200. - Meta
metaobject - Customer provided metadata about this live stream.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"active_asset_id": "example",
"active_ingest_protocol": "example",
"audio_only": false,
"created_at": "example",
"embedded_subtitles": [],
"generated_subtitles": [],
"id": "example",
"latency_mode": "example",
"low_latency": false,
"max_continuous_duration": 1,
"meta": {
"title": "example"
},
"new_asset_settings": {
"advanced_playback_policies": [],
"copy_overlays": false,
"directives": [],
"encoding_tier": "example",
"generate_shots": false,
"input": [],
"inputs": [],
"master_access": "example",
"max_resolution_tier": "example",
"meta": {
"creator_id": "example",
"external_id": "example",
"title": "example"
},
"mp4_support": "example",
"normalize_audio": false,
"passthrough": "example",
"playback_policies": [],
"playback_policy": [],
"static_renditions": [],
"test": false,
"video_quality": "example"
},
"passthrough": "example",
"playback_ids": [],
"recent_asset_ids": [],
"reconnect_slate_url": "example",
"reconnect_window": 1.0,
"reduced_latency": false,
"simulcast_targets": [],
"srt_passphrase": "example",
"status": "example",
"stream_key": "example",
"test": false,
"use_slate_for_standard_latency": false
}
}
}Delete asset
Deletes a video asset and all its data.
Inputs
- Asset
asset_idtextRequired - The asset ID.
Outputs
dataobject- Result.
Example output
{
"data": {}
}Delete asset playback ID
Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. Please note that deleting the playback ID removes access to the underlying asset; a viewer who started playback before the playback ID was deleted may be able to watch the entire video…
Inputs
- Asset
asset_idtextRequired - The asset ID.
- Playback ID
playback_idtextRequired - The asset or live stream's playback ID.
Outputs
dataobject- Result.
Example output
{
"data": {}
}Delete asset track
Removes a text or additional audio track from an asset. Neither video nor the primary audio track can be removed.
Inputs
- Asset
asset_idtextRequired - The asset ID.
- Track ID
track_idtextRequired - The ID of the track for an asset.
Outputs
dataobject- Result.
Example output
{
"data": {}
}Delete live stream
Deletes a live stream from the current environment. If the live stream is currently active and being streamed to, ingest will be terminated and the encoder will be disconnected.
Inputs
- Live stream
live_stream_idtextRequired - The live stream ID
Outputs
dataobject- Result.
Example output
{
"data": {}
}Disable live stream
Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the EXT-X-ENDLIST tag to the HLS manifest which notifies the player that this live…
Inputs
- Live stream
live_stream_idtextRequired - The live stream ID
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {}
}
}Enable live stream
Enables a live stream, allowing it to accept an incoming RTMP stream.
Inputs
- Live stream
live_stream_idtextRequired - The live stream ID
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {}
}
}Get asset
Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset.
Inputs
- Asset
asset_idtextRequired - The asset ID.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"aspect_ratio": "example",
"created_at": "example",
"directives": [],
"duration": 1.0,
"encoding_tier": "example",
"errors": {
"messages": [],
"type": "example"
},
"generate_shots": false,
"id": "example",
"ingest_type": "example",
"is_live": false,
"live_stream_id": "example",
"master": {
"status": "example",
"url": "example"
},
"master_access": "example",
"max_resolution_tier": "example",
"max_stored_frame_rate": 1.0,
"max_stored_resolution": "example",
"meta": {
"creator_id": "example",
"external_id": "example",
"title": "example"
},
"mp4_support": "example",
"non_standard_input_reasons": {
"audio_codec": "example",
"audio_edit_list": "example",
"pixel_aspect_ratio": "example",
"unexpected_media_file_parameters": "example",
"unsupported_pixel_format": "example",
"video_bitrate": "example",
"video_codec": "example",
"video_edit_list": "example",
"video_frame_rate": "example",
"video_gop_size": "example",
"video_resolution": "example"
},
"normalize_audio": false,
"passthrough": "example",
"playback_ids": [],
"progress": {
"progress": 1.0,
"state": "example"
},
"recording_times": [],
"resolution_tier": "example",
"shots": {
"created_at": "example",
"errors": {
"messages": [],
"type": "example"
},
"shots_manifest_url": "example",
"status": "example"
},
"source_asset_id": "example",
"static_renditions": {
"files": [],
"status": "example"
},
"status": "example",
"test": false,
"thumbnail_time": 1.0,
"tracks": [],
"upload_id": "example",
"video_quality": "example"
}
}
}Get direct upload
Fetches information about a single direct upload in the current environment.
Inputs
- Upload
upload_idtextRequired - ID of the Upload
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"asset_id": "example",
"cors_origin": "example",
"error": {
"message": "example",
"type": "example"
},
"id": "example",
"new_asset_settings": {
"advanced_playback_policies": [],
"copy_overlays": false,
"directives": [],
"encoding_tier": "example",
"generate_shots": false,
"input": [],
"inputs": [],
"master_access": "example",
"max_resolution_tier": "example",
"meta": {
"creator_id": "example",
"external_id": "example",
"title": "example"
},
"mp4_support": "example",
"normalize_audio": false,
"passthrough": "example",
"playback_policies": [],
"playback_policy": [],
"static_renditions": [],
"test": false,
"video_quality": "example"
},
"status": "example",
"test": false,
"timeout": 1,
"url": "example"
}
}
}Get live stream
Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.
Inputs
- Live stream
live_stream_idtextRequired - The live stream ID
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"active_asset_id": "example",
"active_ingest_protocol": "example",
"audio_only": false,
"created_at": "example",
"embedded_subtitles": [],
"generated_subtitles": [],
"id": "example",
"latency_mode": "example",
"low_latency": false,
"max_continuous_duration": 1,
"meta": {
"title": "example"
},
"new_asset_settings": {
"advanced_playback_policies": [],
"copy_overlays": false,
"directives": [],
"encoding_tier": "example",
"generate_shots": false,
"input": [],
"inputs": [],
"master_access": "example",
"max_resolution_tier": "example",
"meta": {
"creator_id": "example",
"external_id": "example",
"title": "example"
},
"mp4_support": "example",
"normalize_audio": false,
"passthrough": "example",
"playback_policies": [],
"playback_policy": [],
"static_renditions": [],
"test": false,
"video_quality": "example"
},
"passthrough": "example",
"playback_ids": [],
"recent_asset_ids": [],
"reconnect_slate_url": "example",
"reconnect_window": 1.0,
"reduced_latency": false,
"simulcast_targets": [],
"srt_passphrase": "example",
"status": "example",
"stream_key": "example",
"test": false,
"use_slate_for_standard_latency": false
}
}
}Get resource by playback ID
Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
Inputs
- Playback ID
playback_idtextRequired - The asset or live stream's playback ID.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"id": "example",
"object": {
"id": "example",
"type": "example"
},
"policy": "example"
}
}
}List assets
List all Mux assets.
Inputs
- Limit
limitnumber - Number of items to include in the responseDefault:
25. - Cursor
cursortext - This parameter is used to request pages beyond the first. You can find the cursor value in the next_cursor field of paginated responses.
- Live stream
live_stream_idtext - Filter response to return all the assets for this live stream only
- Upload
upload_idtext - Filter response to return an asset created from this direct upload only
Outputs
dataobject- Result.
Example output
{
"data": {
"data": [],
"next_cursor": "example"
}
}List direct uploads
Lists direct uploads in the current environment.
Inputs
- Limit
limitnumber - Number of items to include in the responseDefault:
25. - Page
pagenumber - Offset by this many pages, of the size of limitDefault:
1.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": []
}
}List live streams
Lists the live streams that currently exist in the current environment.
Inputs
- Limit
limitnumber - Number of items to include in the responseDefault:
25. - Page
pagenumber - Offset by this many pages, of the size of limitDefault:
1. - Stream key
stream_keytext - Filter response to return live stream for this stream key only
- Status
statustext - Filter response to return live streams with the specified status onlyOne of:
active,idle,disabled.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": []
}
}Update asset
Updates the details of an existing Asset with the provided Asset ID. This API currently only supports the passthrough, meta and thumbnail_time fields.
Inputs
- Asset
asset_idtextRequired - The asset ID.
- Passthrough
passthroughtext - You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as title or external_id , you can use the meta object instead. Max: 255 characters. In order to clear this value,…
- Meta
metaobject - Customer provided metadata about this asset.
- Thumbnail time
thumbnail_timenumber - The media time within the asset used when a thumbnail without an explicit time is requested.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"aspect_ratio": "example",
"created_at": "example",
"directives": [],
"duration": 1.0,
"encoding_tier": "example",
"errors": {
"messages": [],
"type": "example"
},
"generate_shots": false,
"id": "example",
"ingest_type": "example",
"is_live": false,
"live_stream_id": "example",
"master": {
"status": "example",
"url": "example"
},
"master_access": "example",
"max_resolution_tier": "example",
"max_stored_frame_rate": 1.0,
"max_stored_resolution": "example",
"meta": {
"creator_id": "example",
"external_id": "example",
"title": "example"
},
"mp4_support": "example",
"non_standard_input_reasons": {
"audio_codec": "example",
"audio_edit_list": "example",
"pixel_aspect_ratio": "example",
"unexpected_media_file_parameters": "example",
"unsupported_pixel_format": "example",
"video_bitrate": "example",
"video_codec": "example",
"video_edit_list": "example",
"video_frame_rate": "example",
"video_gop_size": "example",
"video_resolution": "example"
},
"normalize_audio": false,
"passthrough": "example",
"playback_ids": [],
"progress": {
"progress": 1.0,
"state": "example"
},
"recording_times": [],
"resolution_tier": "example",
"shots": {
"created_at": "example",
"errors": {
"messages": [],
"type": "example"
},
"shots_manifest_url": "example",
"status": "example"
},
"source_asset_id": "example",
"static_renditions": {
"files": [],
"status": "example"
},
"status": "example",
"test": false,
"thumbnail_time": 1.0,
"tracks": [],
"upload_id": "example",
"video_quality": "example"
}
}
}Update live stream
Updates the parameters of a previously-created live stream. This currently supports a subset of variables. Supply the live stream ID and the updated parameters and Mux will return the corresponding live stream information. The information returned will be the same after…
Inputs
- Live stream
live_stream_idtextRequired - The live stream ID
- Passthrough
passthroughtext - Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value.
- Latency mode
latency_modetext - Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags.One of:
low,reduced,standard. - Reconnect window
reconnect_windownumber - When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the…From 0 to 1800. Default:
60. - Use slate for standard latency
use_slate_for_standard_latencytrue/false - By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream.Default:
false. - Reconnect slate URL
reconnect_slate_urltext - The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the…
- Max continuous duration
max_continuous_durationnumber - The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.From 60 to 43200. Default:
43200. - New asset settings
new_asset_settingsobject - Updates the new asset settings to use to generate a new asset for this live stream. Only the mp4_support, master_access, and video_quality settings may be updated.
- Meta
metaobject - Customer provided metadata about this live stream.
Outputs
dataobject- Result.
Example output
{
"data": {
"data": {
"active_asset_id": "example",
"active_ingest_protocol": "example",
"audio_only": false,
"created_at": "example",
"embedded_subtitles": [],
"generated_subtitles": [],
"id": "example",
"latency_mode": "example",
"low_latency": false,
"max_continuous_duration": 1,
"meta": {
"title": "example"
},
"new_asset_settings": {
"advanced_playback_policies": [],
"copy_overlays": false,
"directives": [],
"encoding_tier": "example",
"generate_shots": false,
"input": [],
"inputs": [],
"master_access": "example",
"max_resolution_tier": "example",
"meta": {
"creator_id": "example",
"external_id": "example",
"title": "example"
},
"mp4_support": "example",
"normalize_audio": false,
"passthrough": "example",
"playback_policies": [],
"playback_policy": [],
"static_renditions": [],
"test": false,
"video_quality": "example"
},
"passthrough": "example",
"playback_ids": [],
"recent_asset_ids": [],
"reconnect_slate_url": "example",
"reconnect_window": 1.0,
"reduced_latency": false,
"simulcast_targets": [],
"srt_passphrase": "example",
"status": "example",
"stream_key": "example",
"test": false,
"use_slate_for_standard_latency": false
}
}
}