Skip to main content

Search

Ravnur Knowledge Base

Streaming locator - List paths

Alla Blinova
  • Updated

In this article:

URI Parameters
Responses
Examples
Definitions

 

List paths supported by this streaming locator.

POST https://{{api-endpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listPaths?api-version={api-version}

 

URI Parameters

Name In Required Type Description
accountName path True string The Media Services 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.
streamingLocatorName path True string The Streaming Locator name.
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.

 

Responses

Name Type Description
200 OK ListPathsResponse OK
Other Status Codes ErrorResponse Detailed error information.

 

Examples

List paths that have streaming paths and download paths
List paths that have streaming paths only

List paths that have streaming paths and download paths

POST https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators/clearStreamingLocator/listPaths?api-version={api-version}

Sample response

Status code: 200

{
    "streamingPaths": [
        {
            "streamingProtocol": "Hls",
            "paths": [
                "/262a87b6-b538-4657-bac1-b6897924471d/manifest.ism/manifest(format=m3u8-cmaf)"
            ]
        },
        {
            "streamingProtocol": "Dash",
            "paths": [
                "/262a87b6-b538-4657-bac1-b6897924471d/manifest.ism/manifest(format=mpd-time-cmaf)"
            ]
        }
    ],
    "downloadPaths": [
        "/262a87b6-b538-4657-bac1-b6897924471d/video.mp4",
        "/262a87b6-b538-4657-bac1-b6897924471d/manifest.ism"
    ]
}

 

List Paths that have streaming paths only

POST https://{{api-endpoint}}/subscriptions//00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators/clearStreamingLocator/listPaths?api-version={api-version}

Sample response

Status code: 200

{
    "streamingPaths": [
        {
            "streamingProtocol": "Hls",
            "paths": [
                "/262a87b6-b538-4657-bac1-b6897924471d/My video.ism/manifest(format=m3u8-cmaf)"
            ]
        },
        {
            "streamingProtocol": "Dash",
            "paths": [
                "/262a87b6-b538-4657-bac1-b6897924471d/My video.ism/manifest(format=mpd-time-cmaf)"
            ]
        }
    ],
    "downloadPaths": []
}

 

Definitions

Name Description
EncryptionScheme Encryption scheme.
ErrorAdditionalInfo The resource management error additional info.
ErrorDetail The error detail.
ErrorResponse Error response.
ListPathsResponse Class of response for listPaths action.
StreamingPath Class for content key in Streaming Locator
StreamingPolicyStreamingProtocol Streaming protocol.

 

EncryptionScheme

Encryption scheme.

Name Type Description
CommonEncryptionCbcs string CommonEncryptionCbcs scheme.
CommonEncryptionCenc string CommonEncryptionCenc scheme.
NoEncryption string NoEncryption scheme.

 

ErrorAdditionalInfo

The resource management error additional info.

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

 

ErrorDetail

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

Name Type Description
error ErrorDetail The error object.

 

ListPathsResponse

Class of response for listPaths action.

Name Type Description
downloadPaths string[] Download Paths supported by current streaming locator.
Streaming Paths StreamingPath[] Streaming Paths supported by current streaming locator.

 

StreamingPath

Class of paths for streaming.

Name Type Description
encryptionScheme EncryptionScheme Encryption scheme.
paths string[] Streaming paths for each protocol and encryptionScheme pair.
streamingProtocol StreamingPolicyStreamingProtocol Streaming protocol.

 

StreamingPolicyStreamingProtocol

Streaming protocol.

Name Type Description
Dash string DASH protocol.
Download string Download protocol.
Hls string Hls protocol.

 

Powered by Zendesk