Get Started
Studio API
- Introduction
- Streaming
- Live Streams
- Simulcasts
- Clips
- Videos
- Video Protection
- Configurations
- Assets
- CMS
- OTT
- Monetization
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
List configurations
ListConfigurations
Return list of configurations.
curl --request GET \
--url https://api.mottostreaming.com/streaming/configurations/v1 \
--header 'Authorization: Bearer <token>'
{
"configurations": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"description": "<string>",
"default": true,
"disabled": true,
"type": "CONFIGURATION_TYPE_UNSPECIFIED",
"data": {
"transcoder_streams": {
"streams": [
{
"video_quality": "VIDEO_QUALITY_UNSPECIFIED",
"video_aspect_ratio": "VIDEO_ASPECT_RATIO_UNSPECIFIED",
"video_bitrate": 123,
"video_framerate": 123,
"video_keyframe_interval": 123,
"segment_duration": 123
}
]
},
"transcoder_overlays": {
"static_overlays": [
{
"asset_id": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123
}
]
},
"automated_tagging": {
"enabled": true
}
}
}
],
"next_page_token": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Maximum number of records to return
If this field is not empty then it must contain the next_page_token
value
returned by a previous call to this method. Using this field causes the
method to return additional results from the previous method call.
ID of the project for which configurations are returned.
Filter the result-set by properties using a subset of the Kibana Query Language. Only AND statements are supported.
Can be used to find the configurations attached to a workflow using workflow_id:xyz
Response
The name of the configuration.
The description of the configuration.
Indicates whether this configuration should be applied by default when no configuration is attached to a workflow or simulcast. There can only be one default configuration per type.
Indicates that the configuration should not appear as a selectable option in the UI. This configuration will still be usable by any object it is connected to.
The type of the configuration. This is used to determine which configuration options are available.
CONFIGURATION_TYPE_UNSPECIFIED
, CONFIGURATION_TYPE_TRANSCODER_STREAMS
, CONFIGURATION_TYPE_TRANSCODER_OVERLAYS
, CONFIGURATION_TYPE_AUTOMATED_TAGGING
The data for the configuration based on the type.
The configuration is for transcoder streams.
A transcoder can have multiple streams. Each stream will be transcoded separately.
The transcoder stream configuration
The quality of the video stream. Together with the aspect ratio, this will determine the resolution of the transcoded video.
VIDEO_QUALITY_UNSPECIFIED
, VIDEO_QUALITY_240P
, VIDEO_QUALITY_360P
, VIDEO_QUALITY_480P
, VIDEO_QUALITY_720P
, VIDEO_QUALITY_1080P
, VIDEO_QUALITY_1440P
, VIDEO_QUALITY_2160P
The aspect ratio of the video stream. Together with the quality, this will determine the resolution of the transcoded video.
VIDEO_ASPECT_RATIO_UNSPECIFIED
, VIDEO_ASPECT_RATIO_16_9
, VIDEO_ASPECT_RATIO_9_16
The bitrate of the video stream in bits per second for the transcoded output. This is the target bitrate, the actual bitrate may vary slightly.
The framerate of the video stream in frames per second for the transcoded output. This is the target framerate, the actual framerate may vary slightly.
The interval between key frames in seconds for the transcoded output. It must not be longer than segment duration. Is it recommended to set this to a divisor of the segment duration (e.g. 2 seconds for a 6-second segment duration).
The output segment size in seconds. Motto currently supports values between 4 and 10 seconds. For low-latency streaming (e.g. LL-HLS), please consult the documentation or contact Motto support.
The configuration is for transcoder overlays (e.g. logos, watermarks).
A list of static image overlays that should be applied to the transcoded video. For dynamic overlays (e.g. scoreboards or moving sponsorship graphics), please consult the documentation or contact Motto support.
The static overlay configuration
The Motto asset ID of the overlay image.
The horizontal position of the overlay as a fraction between 0 and 1, where 0 indicates the left edge of the video, and 1 the right edge.
The vertical position of the overlay as a fraction between 0 and 1, where 0 indicates the top edge of the video, and 1 the bottom edge.
A value between 0 and 1 that indicates the width of the overlay image as a percentage of the video width.
A value between 0 and 1 that indicates the height of the overlay image as a percentage of the video height. If not set while width is known, the aspect ratio of the image will be preserved.
If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as page_token
in the next call to this method.
curl --request GET \
--url https://api.mottostreaming.com/streaming/configurations/v1 \
--header 'Authorization: Bearer <token>'
{
"configurations": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"description": "<string>",
"default": true,
"disabled": true,
"type": "CONFIGURATION_TYPE_UNSPECIFIED",
"data": {
"transcoder_streams": {
"streams": [
{
"video_quality": "VIDEO_QUALITY_UNSPECIFIED",
"video_aspect_ratio": "VIDEO_ASPECT_RATIO_UNSPECIFIED",
"video_bitrate": 123,
"video_framerate": 123,
"video_keyframe_interval": 123,
"segment_duration": 123
}
]
},
"transcoder_overlays": {
"static_overlays": [
{
"asset_id": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123
}
]
},
"automated_tagging": {
"enabled": true
}
}
}
],
"next_page_token": "<string>"
}