Skip to main content

Search

Ravnur Knowledge Base

Live Events - List

Alla Blinova
  • Updated

AMS compatibility note
RMS accepts a small set of AMS fields to keep SDK and payload compatibility.

Labelling legend:

[No-op in RMS] – accepted for AMS compatibility; ignored by RMS, meaning that they can be omitted as changes to them will not affect Live Events' behavior.
[Not emitted by RMS] – present in AMS docs; RMS never returns this value.

 

In this article:

URI Parameters

Responses

Examples

Definitions

 

Lists all the live events in the account.

GET https://{{api-endpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents?api-version={api-version}

With optional parameters:

GET https://{{api-endpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents?api-version={api-version}&$filter={$filter}&$orderby={$orderby}

 

URI Parameters

Name In Required Type Description
accountName path True string The RMS account name.
resourceGroupName path True string The name of the resource group within the Azure subscription.
subscriptionId path True string The unique identifier for a Microsoft Azure subscription.
api-version query True: value can be any. string

The version of the API to be used with the client request.

Required for compatibility; any value accepted; no effect.
$filter query   string Restricts the set of items returned.
$orderby query   string Specifies the key by which the result collection should be ordered.

 

Responses

Name Type Description
200 OK LiveEventListResult

OK. The request has succeeded.
Other Status Codes ErrorResponse Detailed error information.

 

Examples

Lists the live events
Lists the live events ordered by date
Lists the live events filtered by name
Lists the live events filtered by ResourceState

 

List all live events

Lists all the live events in the account.

Sample Request

GET https://{{api-endpoint}}/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents?api-version=2022-11-01

Sample response

Status code: 200

Response Body

{
  "value": [
    {
      "location": "string",
      "properties": {
        "description": "string",
        "input": {
          "streamingProtocol": "string",
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "Allow All",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "keyFrameIntervalDuration": "string",
          "accessToken": "string",
          "endpoints": [
            {
              "protocol": "string",
              "url": "string"
            },
            {
              "protocol": "string",
              "url": "string"
            }
          ]
        },
        "preview": {
          "endpoints": [
            {
              "protocol": "string",
              "url": "string"
            }
          ],
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "Allow All",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "previewLocator": "string",
          "streamingPolicyName": "string"
        },
        "encoding": {
          "encodingType": "Premium1080p",
          "presetName": "string",
          "isDVRSource": true
        },
        "transcriptions": [],
        "provisioningState": "string",
        "resourceState": "Stopped",
        "crossSiteAccessPolicies": {},
        "useStaticHostname": true,
        "hostnamePrefix": "string",
        "streamOptions": [
          "Default"
        ],
        "created": "2025-02-21T08:06:51.5035641Z",
        "lastModified": "2025-02-21T08:06:51.5035641Z"
      },
      "systemData": {
        "createdBy": "system",
        "createdByType": "Application",
        "createdAt": "2025-02-21T08:06:51.5035641Z",
        "lastModifiedBy": "system",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2025-02-21T08:06:51.5035641Z"
      },
      "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents/myLiveEvent1",
      "name": "myLiveEvent1",
      "type": "Microsoft.Media/mediaservices/liveEvents"
    },
    {
      "location": "string",
      "properties": {
        "description": "string",
        "input": {
          "streamingProtocol": "string",
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "Allow All",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "keyFrameIntervalDuration": "string",
          "accessToken": "string",
          "endpoints": [
            {
              "protocol": "string",
              "url": "string"
            },
            {
              "protocol": "string",
              "url": "string"
            }
          ]
        },
        "preview": {
          "endpoints": [
            {
              "protocol": "string",
              "url": "string"
            }
          ],
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "Allow All",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "previewLocator": "string",
          "streamingPolicyName": "string"
        },
        "encoding": {
          "encodingType": "Standard",
          "presetName": "string",
          "isDVRSource": true
        },
        "transcriptions": [],
        "provisioningState": "string",
        "resourceState": "Stopped",
        "crossSiteAccessPolicies": {},
        "useStaticHostname": true,
        "hostnamePrefix": "string",
        "streamOptions": [
          "Default"
        ],
        "created": "2025-02-19T15:39:36.3442903Z",
        "lastModified": "2025-02-19T15:39:36.3442903Z"
      },
      "systemData": {
        "createdBy": "system",
        "createdByType": "Application",
        "createdAt": "2025-02-19T15:39:36.3442903Z",
        "lastModifiedBy": "system",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2025-02-19T15:39:36.3442903Z"
      },
      "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents/myLiveEvent2",
      "name": "myLiveEvent2",
      "type": "Microsoft.Media/mediaservices/liveEvents"
    }
  ]
}

Lists the live events ordered by date

Lists the live events ordered by the creation.

Sample Request

GET https://{{api-endpoint}}/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents?api-version=2022-11-01&$orderby=properties/created desc

Sample response

Status code: 200

Response Body

{
  "value": [
    {
      "location": "string",
      "properties": {
        "description": "string",
        "input": {
          "streamingProtocol": "string",
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "Allow All",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "keyFrameIntervalDuration": "string",
          "accessToken": "string",
          "endpoints": [
            {
              "protocol": "string",
              "url": "string"
            },
            {
              "protocol": "string",
              "url": "string"
            }
          ]
        },
        "preview": {
          "endpoints": [
            {
              "protocol": "string",
              "url": "string"
            }
          ],
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "Allow All",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "previewLocator": "string",
          "streamingPolicyName": "string"
        },
        "encoding": {
          "encodingType": "Premium1080p",
          "presetName": "string",
          "isDVRSource": true
        },
        "transcriptions": [],
        "provisioningState": "string",
        "resourceState": "Stopped",
        "crossSiteAccessPolicies": {},
        "useStaticHostname": true,
        "hostnamePrefix": "string",
        "streamOptions": [
          "Default"
        ],
        "created": "2025-02-21T08:06:51.5035641Z",
        "lastModified": "2025-02-21T08:06:51.5035641Z"
      },
      "systemData": {
        "createdBy": "system",
        "createdByType": "Application",
        "createdAt": "2025-02-21T08:06:51.5035641Z",
        "lastModifiedBy": "system",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2025-02-21T08:06:51.5035641Z"
      },
      "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents/myLiveEvent1",
      "name": "myLiveEvent1",
      "type": "Microsoft.Media/mediaservices/liveEvents"
    },
    {
      "location": "string",
      "properties": {
        "description": "string",
        "input": {
          "streamingProtocol": "string",
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "Allow All",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "keyFrameIntervalDuration": "string",
          "accessToken": "string",
          "endpoints": [
            {
              "protocol": "string",
              "url": "string"
            },
            {
              "protocol": "string",
              "url": "string"
            }
          ]
        },
        "preview": {
          "endpoints": [
            {
              "protocol": "string",
              "url": "string"
            }
          ],
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "Allow All",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "previewLocator": "string",
          "streamingPolicyName": "string"
        },
        "encoding": {
          "encodingType": "Standard",
          "presetName": "string",
          "isDVRSource": true
        },
        "transcriptions": [
          {
            "language": "string",
            "inputTrackSelection": [
              {
                "property": "string",
                "operation": "string",
                "value": "string"
              }
            ],
            "outputTranscriptionTrack": {
              "trackName": "string"
            }
          }
        ],
        "provisioningState": "string",
        "resourceState": "Stopped",
        "crossSiteAccessPolicies": {
          "clientAccessPolicy": "string",
          "crossDomainPolicy": "string"
        },
        "useStaticHostname": true,
        "hostnamePrefix": "string",
        "streamOptions": [
          "Default"
        ],
        "created": "2025-08-21T14:51:38.101Z",
        "lastModified": "2025-08-21T14:51:38.101Z"
      },
      "systemData": {
        "createdBy": "system",
        "createdByType": "Application",
        "createdAt": "2025-08-21T14:51:38.101Z",
        "lastModifiedBy": "system",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2025-08-21T14:51:38.101Z"
      },
      "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents/myLiveEvent2",
      "name": "myLiveEvent2",
      "type": "Microsoft.Media/mediaservices/liveEvents"
    }
  ]
}

 

Lists the  live events by name

Lists the live events filtered by name.

Sample Request

GET https://{{api-endpoint}}/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents?api-version=2022-11-01&$filter=name eq'1096'

Sample response

Status code: 200

Response Body

{
    "value": [
        {
            "location": "string",
            "properties": {
                "description": "string",
                "input": {
                    "streamingProtocol": "string",
                    "accessControl": {
                        "ip": {
                            "allow": [
                                {
                                    "name": "Allow All",
                                    "address": "0.0.0.0",
                                    "subnetPrefixLength": 0
                                }
                            ]
                        }
                    },
                    "keyFrameIntervalDuration": "string",
                    "accessToken": "string",
                    "endpoints": [
                        {
                            "protocol": "string",
                            "url": "string"
                        },
                        {
                            "protocol": "string",
                            "url": "string"
                        }
                    ]
                },
                "preview": {
                    "endpoints": [
                        {
                            "protocol": "string",
                            "url": "string"
                        }
                    ],
                    "accessControl": {
                        "ip": {
                            "allow": [
                                {
                                    "name": "Allow All",
                                    "address": "0.0.0.0",
                                    "subnetPrefixLength": 0
                                }
                            ]
                        }
                    },
                    "previewLocator": "string",
                    "streamingPolicyName": "string"
                },
                "encoding": {
                    "encodingType": "Standard",
                    "presetName": "string",
                    "isDVRSource": true
                },
                "transcriptions": [],
                "provisioningState": "string",
                "resourceState": "Stopped",
                "crossSiteAccessPolicies": {},
                "useStaticHostname": true,
                "hostnamePrefix": "string",
                "streamOptions": [
                    "Default"
                ],
                "created": "2025-02-19T15:39:36.3442903Z",
                "lastModified": "2025-02-19T15:39:36.3442903Z"
            },
            "systemData": {
                "createdBy": "system",
                "createdByType": "Application",
                "createdAt": "2025-02-19T15:39:36.3442903Z",
                "lastModifiedBy": "system",
                "lastModifiedByType": "Application",
                "lastModifiedAt": "2025-02-19T15:39:36.3442903Z"
            },
            "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents/1096",
            "name": "1096",
            "type": "Microsoft.Media/mediaservices/liveEvents"
        }
    ]
}

 

Lists the live events by LiveEventResourceState

Lists the live events filtered by resource state.

Sample Request

GET https://{{api-endpoint}}/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents?api-version=2022-11-01&$filter=properties/resourceState eq'Stopped'

Sample response

Status code: 200

Response Body

{
    "value": [
        {
            "location": "string",
            "properties": {
                "description": "string",
                "input": {
                    "streamingProtocol": "string",
                    "accessControl": {
                        "ip": {
                            "allow": [
                                {
                                    "name": "Allow All",
                                    "address": "0.0.0.0",
                                    "subnetPrefixLength": 0
                                }
                            ]
                        }
                    },
                    "keyFrameIntervalDuration": "string",
                    "accessToken": "string",
                    "endpoints": [
                        {
                            "protocol": "string",
                            "url": "string"
                        },
                        {
                            "protocol": "string",
                            "url": "string"
                        }
                    ]
                },
                "preview": {
                    "endpoints": [
                        {
                            "protocol": "string",
                            "url": "string"
                        }
                    ],
                    "accessControl": {
                        "ip": {
                            "allow": [
                                {
                                    "name": "Allow All",
                                    "address": "0.0.0.0",
                                    "subnetPrefixLength": 0
                                }
                            ]
                        }
                    },
                    "previewLocator": "string",
                    "streamingPolicyName": "string"
                },
                "encoding": {
                    "encodingType": "Standard",
                    "presetName": "string",
                    "isDVRSource": true
                },
                "transcriptions": [],
                "provisioningState": "string",
                "resourceState": "Stopped",
                "crossSiteAccessPolicies": {},
                "useStaticHostname": true,
                "hostnamePrefix": "string",
                "streamOptions": [
                    "Default"
                ],
                "created": "2025-02-19T15:39:36.3442903Z",
                "lastModified": "2025-02-19T15:39:36.3442903Z"
            },
            "systemData": {
                "createdBy": "system",
                "createdByType": "Application",
                "createdAt": "2025-02-19T15:39:36.3442903Z",
                "lastModifiedBy": "system",
                "lastModifiedByType": "Application",
                "lastModifiedAt": "2025-02-19T15:39:36.3442903Z"
            },
            "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents/myLiveEvent1",
            "name": "myLiveEvent1",
            "type": "Microsoft.Media/mediaservices/liveEvents"
        },
        {
            "location": "string",
            "properties": {
                "description": "string",
                "input": {
                    "streamingProtocol": "string",
                    "accessControl": {
                        "ip": {
                            "allow": [
                                {
                                    "name": "Allow All",
                                    "address": "0.0.0.0",
                                    "subnetPrefixLength": 0
                                }
                            ]
                        }
                    },
                    "keyFrameIntervalDuration": "string",
                    "accessToken": "string",
                    "endpoints": [
                        {
                            "protocol": "string",
                            "url": "string"
                        },
                        {
                            "protocol": "string",
                            "url": "string"
                        }
                    ]
                },
                "preview": {
                    "endpoints": [
                        {
                            "protocol": "string",
                            "url": "string"
                        }
                    ],
                    "accessControl": {
                        "ip": {
                            "allow": [
                                {
                                    "name": "Allow All",
                                    "address": "0.0.0.0",
                                    "subnetPrefixLength": 0
                                }
                            ]
                        }
                    },
                    "previewLocator": "string",
                    "streamingPolicyName": "string"
                },
                "encoding": {
                    "encodingType": "Premium1080p",
                    "presetName": "string",
                    "isDVRSource": true
                },
                "transcriptions": [],
                "provisioningState": "string",
                "resourceState": "Stopped",
                "crossSiteAccessPolicies": {},
                "useStaticHostname": true,
                "hostnamePrefix": "string",
                "streamOptions": [
                    "Default"
                ],
                "created": "2025-02-21T08:06:51.5035641Z",
                "lastModified": "2025-02-21T08:06:51.5035641Z"
            },
            "systemData": {
                "createdBy": "string",
                "createdByType": "Application",
                "createdAt": "2025-02-21T08:06:51.5035641Z",
                "lastModifiedBy": "string",
                "lastModifiedByType": "Application",
                "lastModifiedAt": "2025-02-21T08:06:51.5035641Z"
            },
            "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaservices/default/liveEvents/myLiveEvent2",
            "name": "myLiveEvent2",
            "type": "Microsoft.Media/mediaservices/liveEvents"
        }
    ]
}

 

Definitions

Name Description RMS support
createdByType The type of identity that created the resource. Yes
CrossSiteAccessPolicies The client access policy. [No-op]
ErrorAdditionalInfo The resource management error additional info. Yes
ErrorDetail The error detail. Yes
ErrorResponse Error response. Yes
IPAccessControl The IP access control. [No-op]
IPRange The IP address range in the CIDR scheme. [No-op]
LiveEvent The live event. Yes
LiveEventEncoding Specifies the live event type and optional encoding settings for encoding live events. Yes
LiveEventEncodingType Live event type configuration for transcoding or pass-through of incoming streams. Yes
LiveEventEndpoint The live event endpoint. Yes
LiveEventInput The live event input. Yes
LiveEventInputAccessControl The IP access control for live event input. [No-op]
LiveEventInputProtocol The input protocol for the live event. Yes
LiveEventInput (protocol-specific options) Additional input properties that appear only when input.streamingProtocol is SRT or RTSPPull. Yes
LiveEventInputTrackSelection A track selection condition. Reserved for future use; ignored by RMS. Yes
LiveEventListResult A collection of live events. Yes
LiveEventOutputTranscriptionTrack Describes a transcription track in the output of a live event. Reserved for future use. [No-op]
LiveEventResourceState The resource state of the live event. Yes
LiveEventTimedMetadataEndpoint The live event metadata insertion endpoint. [No-op]
LiveEventTranscription Describes the transcription tracks in the output of a live event. Reserved for future use. [No-op]
StretchMode Specifies how the input video will be resized to fit the desired output resolution(s). [No-op]
systemData Metadata pertaining to creation and last modification of the resource. Yes

 

createdByType

The type of identity that created the resource.

Name Type
Application string
Key string
ManagedIdentity string
User string

 

CrossSiteAccessPolicies

[No-op in RMS] 

RMS does not use or emit values for this object.

The client access policy.

Name Type Description

clientAccessPolicy

 string The content of clientaccesspolicy.xml used by Silverlight.

crossDomainPolicy

 string

The content of crossdomain.xml used by Silverlight.

 

 

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info object The additional info.
type string The additional info type.

 

ErrorDetail

The error detail.

Name Type Description
additionalInfo ErrorAdditionalInfo The error additional info.
code string The error code.
details ErrorDetail The error details.
message string The error message.
target string The error target.

 

ErrorResponse

Error response

Name Type Description
error ErrorDetail The error object.

 

IPAccessControl

[No-op in RMS] 

RMS does not use or emit values for this object.

The IP access control.

Name Type Description
allow IPRange[] The IP allow list.

 

IPRange

[No-op in RMS] 

RMS does not use or emit values for this object.

The IP address range in the CIDR scheme.

Name Type Description
address string The IP address.
name string The friendly name for the IP address range.
subnetPrefixLength integer The subnet mask prefix length (see CIDR notation).

 

LiveEvent

The live event.

Name Type Description
id string

Fully qualified resource ID for the resource. Ex - 

/subscriptions/{subscriptionId}/resource
Groups/{resourceGroupName}/providers/
{resourceProviderNamespace}/{resource
Type}/{resourceName}
location string

Azure region field is accepted for AMS compatibility, but has no effect in RMS.

Required for compatibility; any value accepted; no effect.
name string The name of the resource
properties.created string The creation time for the live event
properties.description string A description for the live event.
properties.encoding LiveEventEncoding Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used.
properties.input LiveEventInput Live event input settings. It defines how the live event receives input from a contribution encoder.
properties.lastModified string The last modified time of the live event.
properties.resourceState LiveEventResourceState The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information.
properties.streamOptions string[] The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'.
systemData systemData The system metadata relating to this resource.
tags object

Resource tags.
type string The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

properties.crossSiteAccessPolicies

 CrossSiteAccessPolicies

[No-op in RMS]

Live event cross site access policies.

Legacy Silverlight XML. Omit.

properties.hostnamePrefix

string

[No-op in RMS]

Accepted for AMS payload compatibility. In AMS, when useStaticHostname is true, this is the first part of the static hostname for preview/ingest endpoints (combined with the Media Services account name and a regional code). RMS does not allocate static hostnames, so this value is ignored and has no effect on endpoint URLs. Any value is accepted; you may omit it.

RMS does not separate “preview” and “broadcast” endpoints. The same ingest/output link is used for both previewing and streaming live content. All preview-related parameters from AMS are ignored and have been removed from this API reference.
properties.provisioningState string

[No-op in RMS]

The provisioning state of the live event.

Any value is accepted; you may omit it.

properties.transcriptions

 LiveEventTranscription[]

[No-op in RMS]

Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. Live transcription is in development by RMS.

properties.useStaticHostname

boolean

[No-op in RMS]

Accepted for AMS payload compatibility. In AMS, when useStaticHostname is true, this is the first part of the static hostname for preview/ingest endpoints (combined with the Media Services account name and a regional code). RMS does not allocate static hostnames, so this value is ignored and has no effect on endpoint URLs. Any value is accepted; you may omit it.

RMS does not separate “preview” and “broadcast” endpoints. The same ingest/output link is used for both previewing and streaming live content. All preview-related parameters from AMS are ignored and have been removed from this API reference.

 

LiveEventEncoding

Specifies the live event type and optional encoding settings for encoding live events.

Name Type Description
encodingType LiveEventEncodingType Live event type. When encodingType is set to PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. This property cannot be modified after the live event is created.
isDVRSource boolean

[No-op in RMS]

Enable/disable DVR functionality.

 Value is unconditionally overwritten on create and recomputed on any StreamOptions change from the account-level. To create a no-DVR account, Ravnur support.
keyFrameInterval string

[No-op in RMS]

Accepted for AMS payload compatibility. In AMS, this sets the output fragment length (and video key-frame interval/GoP) for encoding live events (not pass-through), using an ISO-8601 duration (e.g., PT2S). RMS ignores this field and uses service defaults; supplying a value has no effect and may be omitted.
presetName string

[No-op in RMS]

Accepted for AMS payload compatibility. In AMS, this optional preset applies when encodingType ≠ None and is immutable after creation (defaults: Default720p for Standard, Default1080p for Premium1080p). RMS does not apply AMS encoding presets; the value is ignored.
stretchMode stretchMode

[No-op in RMS]

Accepted for AMS payload compatibility. In AMS, controls how input video is resized to match output resolutions (e.g., None, AutoFit, AutoSize). RMS does not use this setting; scaling/letterboxing behavior is determined by the RMS pipeline. Providing this field has no effect.

 

LiveEventEncodingType

Live event type. When encodingType is set to or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. This property cannot be modified after the live event is created.

Name Type Description
PassthroughStandard string The ingested stream passes through the live event from the contribution encoder without any further processing. 
Premium1080p string A contribution live encoder sends a single bitrate stream to the live event and RMS creates multiple bitrate streams. The output cannot exceed 1080p in resolution.
Standard string A contribution live encoder sends a single bitrate stream to the live event and RMS creates multiple bitrate streams. The output cannot exceed 720p in resolution.

 

LiveEventEndpoint

The live event endpoint.

Name Type Description
protocol string The endpoint protocol.
url string The endpoint URL.

 

LiveEventInput

The live event input.

Name Type Description
accessToken string A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value.
endpoints LiveEventEndpoint[] The input endpoints for the live event.
streamingProtocol LiveEventInputProtocol

The input protocol for the live event. This is specified at creation time and cannot be updated.
keyFrameIntervalDuration string

[No-op in RMS]

Accepted for AMS payload compatibility. In AMS, this defined an ISO 8601 duration that controlled the segment duration in the HLS output.

RMS does not use this setting; providing this field has no effect.
accessControl LiveEventInputAccessControl

[No-op in RMS]

Accepted for AMS payload compatibility. In AMS, controls how input video is resized to match output resolutions (e.g., None, AutoFit, AutoSize). RMS does not use this setting; scaling/letterboxing behavior is determined by the RMS pipeline. Providing this field has no effect.
timedMetadataEndpoints LiveEventTimedMetadataEndpoint[]

[No-op in RMS]

Accepted for AMS payload compatibility. In AMS this lists endpoints for timed metadata injection/relay (e.g., ID3/SCTE-35). RMS does not use or emit timed metadata via this array; values are ignored and may be omitted.

 

LiveEventInputAccessControl

[No-op in RMS] 

RMS does not use or emit values for this object.

The IP access control for live event input.

Name Type Description
ip IPAccessControl The IP access control properties.

 

LiveEventInputProtocol

The input protocol for the live event. This is specified at creation time and cannot be updated. See Protocol-specific ingest options for additional fields that appear only for SRT and RTSPPull protocols.

Name Type Description
RTMP string RTMP (Real-Time Messaging Protocol) input will be sent by the contribution encoder to the live event.
SRT string SRT (Secure Reliable Transport) input will be sent by the contribution encoder to the live event.
RTSPPull string RTSP Pull (Real-Time Streaming Protocol) input will be pulled by the live event from the RTSP source endpoint.
RTSPPush string RTSP Push (Real-Time Streaming Protocol) input will be sent by the contribution encoder to the live event.
FragmentedMP4 string

[No-op in RMS]

In AMS, Smooth Streaming input was sent by the contribution encoder to the live event.

FragmentedMP4 is only supported as an output in RMS.

 

Protocol-specific ingest options

LiveEventSRTProtocol

The input protocol for the live event. RMS populates default values. Cannot be specified or updated.

Name Type Description
srtStreamId string The SRT stream ID used to identify and route the ingest stream. This is an arbitrary string the encoder embeds in the SRT handshake, allowing the server to distinguish multiple streams on the same endpoint.
srtPassphrase string Optional passphrase for SRT streams.
srtNodePassphrase string

The passphrase for the SRT relay node. While not described in the visible docs, this is used for securing the hop between the AMS ingest edge node and the internal processing node, analogous to srtPassphrase but scoped to the node-level leg of the connection.
srtLatency integer

[No-op in RMS]

Auto-defaults on create from the 'live.srt.latency' server setting (1000 ms if unset); the client-supplied value is overwritten on create and is immutable on update. Can be modified via Ravnur support request for all new SRT live events.
srtMaxBW integer

[No-op in RMS]

Max bandwidth allowed for SRT in kbps.

Auto-set on create from the 'live.srt.maxbw' server setting (default 50000000); any client-supplied value is unconditionally overwritten and immutable on update (SRT input is not modified in the server). Can be modified via Ravnur support request for all new SRT live events.

 

LiveEventRTSPPullProtocol

The input protocol for the live event. This is specified at creation time and cannot be updated.

RTSP Pull parameters must be specified in two locations in the request body:

  • In tags - IngestOptions.rtspPullUrl and IngestOptions.rtspPullMode.

  • In properties.input - rtspPullMode.

Both are required. The tags store metadata for the resource, while the input property configures the actual streaming behavior. 

Name Required Type Description
IngestOptions.RtspPullUrl true string

The RTSP Pull URL is the address of your video source, typically provided by your IP camera.

When using RTSP Pull, RMS connects to your source and retrieves the stream automatically.
IngestOptions.rtspPullMode   string

Modes for pulling RTSP streams:

  • tcp_udp - prefer TCP; fallback to UDP. Default value.

  • tcp - use TCP only.

  • udp - use UDP only.

  • rtsp_http - RTSP tunneled over HTTP.
IngestOptions.rtspIdleTime   integer

[No-op in RMS]

Accepted for AMS payload compatibility; ignored by RMS in current builds.

Idle time is in development by RMS. Any value is accepted; you may omit it.

 

LiveEventInputTrackSelection

A track selection condition. This property is reserved for future use, any value set on this property will be ignored.

Name Type Description
operation string Comparing operation. This property is reserved for future use, any value set on this property will be ignored.
property string Property name to select. This property is reserved for future use, any value set on this property will be ignored.
value string Property value to select. This property is reserved for future use, any value set on this property will be ignored.

 

LiveEventListResult

A collection of live events.

Name Type Description
@odata.type string A link to the next page of the collection (when the collection contains too many results to return in one response).
value LiveEvent A collection of Live Events.

 

LiveEventOutputTranscriptionTrack

[No-op in RMS] 

Live transcription is in development by RMS.

Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored.

Name Type Description
trackName string The output track name. This property is reserved for future use, any value set on this property will be ignored.

 

LiveEventResourceState

The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information.

Why two representations: name and code for filtering?
RMS exposes properties/resourceState as a string in responses (e.g., "Running"), but the OData filter for this field expects the numeric code shown above.

Name (response value) Code for filtering Type Description
Stopped 1 string This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed.
Starting 4 string The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state.
Running 5 string The live event resources have been allocated, ingest URL have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing.
Stopping 6 string The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state.

Allocating

 -

string

 [Not emitted by RMS] Present in AMS; not surfaced by RMS. The system will set it to Stopped instead.

Deleting

 - string [Not emitted by RMS] Present in AMS; not surfaced by RMS. The system will set it to Stopped instead.

StandBy

 -

string

 [Not emitted by RMS] Present in AMS; not surfaced by RMS. The system will set it to Stopped instead.

 

LiveEventTimedMetadataEndpoint

[No-op in RMS] 

RMS does not use or emit values for this object.

The live event metadata insertion endpoint.

Name Type Description
url string The metadata endpoint URL.
 

LiveEventTranscription

[No-op in RMS] 

Live transcription is in development by RMS.

Describes the transcription tracks in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored.

Name Type Description
inputTrackSelection LiveEventInputTrackSelection[] Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored.
language string Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages.
outputTranscriptionTrack LiveEventOutputTranscriptionTrack Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored.

 

StretchMode

[No-op in RMS] 

RMS does not use or emit values for this object.

Specifies how the input video will be resized to fit the desired output resolution(s). Default is None.

Name Type Description
AutoFit string Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right.
AutoSize string Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9.
None string Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video.

 

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt string The timestamp of resource creation (UTC).
createdBy string The identity that created the resource.
createdByType createdByType The type of identity that created the resource.
lastModifiedAt string The timestamp of resource last modification (UTC)
lastModifiedBy string The identity that last modified the resource.
lastModifiedByType createdByType The type of identity that last modified the resource.
Powered by Zendesk