Streaming Locators - List Paths

List Paths supported by this Streaming Locator

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listPaths?api-version=2022-08-01

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.

streamingLocatorName
path True

string

The Streaming Locator name.

subscriptionId
path True

string

The unique identifier for a Microsoft Azure subscription.

api-version
query True

string

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

Responses

Name Type Description
200 OK

ListPathsResponse

OK

Other Status Codes

ErrorResponse

Detailed error information.

Examples

List Paths which has streaming paths and download paths
List Paths which has streaming paths only

List Paths which has streaming paths and download paths

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators/clearStreamingLocator/listPaths?api-version=2022-08-01

Sample response

{
  "streamingPaths": [
    {
      "streamingProtocol": "Hls",
      "encryptionScheme": "NoEncryption",
      "paths": [
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest(format=m3u8-aapl)",
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest(format=m3u8-aapl)",
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest(format=m3u8-aapl)"
      ]
    },
    {
      "streamingProtocol": "Dash",
      "encryptionScheme": "NoEncryption",
      "paths": [
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest(format=mpd-time-csf)",
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest(format=mpd-time-csf)",
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest(format=mpd-time-csf)"
      ]
    },
    {
      "streamingProtocol": "SmoothStreaming",
      "encryptionScheme": "NoEncryption",
      "paths": [
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest",
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest",
        "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest"
      ]
    }
  ],
  "downloadPaths": [
    "/262a87b6-b538-4657-bac1-b6897924471d/textTrack.vtt",
    "/262a87b6-b538-4657-bac1-b6897924471d/video1.mp4",
    "/262a87b6-b538-4657-bac1-b6897924471d/video2.mp4",
    "/262a87b6-b538-4657-bac1-b6897924471d/video3.mp4"
  ]
}

List Paths which has streaming paths only

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators/secureStreamingLocator/listPaths?api-version=2022-08-01

Sample response

{
  "streamingPaths": [
    {
      "streamingProtocol": "Hls",
      "encryptionScheme": "EnvelopeEncryption",
      "paths": [
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbc)"
      ]
    },
    {
      "streamingProtocol": "Dash",
      "encryptionScheme": "EnvelopeEncryption",
      "paths": [
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cbc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cbc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cbc)"
      ]
    },
    {
      "streamingProtocol": "SmoothStreaming",
      "encryptionScheme": "EnvelopeEncryption",
      "paths": [
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(encryption=cbc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(encryption=cbc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(encryption=cbc)"
      ]
    },
    {
      "streamingProtocol": "Dash",
      "encryptionScheme": "CommonEncryptionCenc",
      "paths": [
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cenc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cenc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cenc)"
      ]
    },
    {
      "streamingProtocol": "SmoothStreaming",
      "encryptionScheme": "CommonEncryptionCenc",
      "paths": [
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(encryption=cenc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(encryption=cenc)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(encryption=cenc)"
      ]
    },
    {
      "streamingProtocol": "Hls",
      "encryptionScheme": "CommonEncryptionCbcs",
      "paths": [
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)",
        "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)"
      ]
    }
  ],
  "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 of paths for streaming

StreamingPolicyStreamingProtocol

Streaming protocol

EncryptionScheme

Encryption scheme

Name Type Description
CommonEncryptionCbcs

string

CommonEncryptionCbcs scheme

CommonEncryptionCenc

string

CommonEncryptionCenc scheme

EnvelopeEncryption

string

EnvelopeEncryption 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

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.

ListPathsResponse

Class of response for listPaths action

Name Type Description
downloadPaths

string[]

Download Paths supported by current Streaming Locator

streamingPaths

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

SmoothStreaming

string

SmoothStreaming protocol