taskName | Name | Description | Request Body | Response Body |
---|
enable-streaming | Enable Streaming task | Enables RTMP streaming for all files within a DuraCloud space through the use of Amazon's Cloudfront streaming capability. This task may take up to 15 minutes to complete. When this call completes, two new properties will have been added to the set of properties for the specified space: - streaming-host - this is the RTMP host value, which can be used to generate URLs for open streams
- streaming-type - will either be OPEN or SECURE, depending on the value of the secure parameter provided when streaming was enabled
| No Format |
---|
{
"spaceId" : "",
"secure" : ""
} |
spaceId - Name of the space for which streaming is to be enabled
secure - true or false, should streaming be secured
No Format |
---|
{
"result" : "",
"streamingHost" : ""
} |
result - Text indicating the results of the task
streamingHost - the host name of the streaming endpoint
disable-streaming | Disable Streaming task | Disables streaming by removing the ability for Cloudfront to access files within a space. This does not remove the streaming distribution, only disables its use, so enabling streaming on the same space again can be performed much more quickly. Some content in the space may continue to be available for streaming up to 24 hours after streaming has been disabled. | No Format |
---|
{
"spaceId" : ""
} |
spaceId - Name of the space for which streaming is to be disabled
No Format |
---|
{
"result" : ""
} |
result - Text indicating the results of the task
delete-streaming | Delete Streaming task | Removes a streaming distribution created by the enable-streaming task. This task should be performed after performing the disable-streaming task. This task may take up to 15 minutes to complete, after which no content in the space will be available for streaming. | No Format |
---|
{
"spaceId" : ""
} |
spaceId - Name of the space for which streaming is to be deleted
No Format |
---|
{
"result" : ""
} |
result - Text indicating the results of the task
get-url | Get URL task | Retrieves a URL for a media file that is streamed through Cloudfront via an open distribution | No Format |
---|
{
"spaceId" : "",
"contentId" : "",
"resourcePrefix" : ""
} |
spaceId - Name of the space in which the streamed content is stored
contentId - Name of the content item to be streamed
resourcePrefix - A prefix on the content item which may be required by the streaming viewer. (e.g. an mp4 file may need a prefix of "mp4:") (optional)
No Format |
---|
{
"streamUrl" : ""
} |
streamUrl - The URL to be used for streaming the requested content
get-signed-url | Get Signed URL task | Retrieves a signed URL for a media file that is streamed through Cloudfront via a secure distribution | No Format |
---|
{
"spaceId" : "",
"contentId" : "",
"minutesToExpire" : "",
"ipAddress" : ""
"resourcePrefix" : ""
} |
spaceId - Name of the space in which the streamed content is stored
contentId - Name of the content item to be streamed
minutesToExpire - Number of minutes until the generated URL expires and the stream can no longer be played (optional, default is 480)
ipAddress - IP address range where requests to stream must originate, in CIDR notation (e.g. 1.2.3.4/32) (optional)
resourcePrefix - A prefix on the content item which may be required by the streaming viewer. (e.g. an mp4 file may need a prefix of "mp4:") (optional)
taskName | Name | Description | Request Body | Response Body |
---|
enable-hls | Enable HLS Streaming task | Enables HTTP Live Streaming (HLS) for all files within a DuraCloud space through the use of Amazon's Cloudfront streaming capability. This task may take up to 15 minutes to complete. When this call completes, two new properties will have been added to the set of properties for the specified space: - hls-streaming-host - this is the HLS host value, which can be used to generate URLs for streaming
- hls-streaming-type - will either be OPEN or SECURE, depending on the value of the secure parameter provided when streaming was enabled
|
No Format |
---|
{
"spaceId" : "",
"secure" : "",
"allowedOrigins" : ["",""]
} |
spaceId - Name of the space for which streaming is to be enabled secure - true or false, should streaming be secured allowedOrigins - A list of allowed origins which limits the domains that may access the content in a streamed space under the CORS security model (optional, default is "https://*") |
No Format |
---|
{
"result" : "",
"streamingHost" : ""
} |
result - Text indicating the results of the task streamingHost - The host name of the streaming endpoint |
disable-hls | Disable HLS Streaming task | Disables streaming by removing the ability for Cloudfront to access files within a space. This does not remove the streaming distribution, only disables its use, so enabling streaming on the same space again can be performed much more quickly. Some content in the space may continue to be available for streaming up to 24 hours after streaming has been disabled. |
No Format |
---|
{
"spaceId" : ""
} |
spaceId - Name of the space for which streaming is to be disabled |
No Format |
---|
{
"result" : ""
} |
result - Text indicating the results of the task |
delete-hls | Delete HLS Streaming task | Removes a streaming distribution created by the enable-streaming task. This task should be performed after performing the disable-streaming task. This task may take up to 15 minutes to complete, after which no content in the space will be available for streaming. This task can be used to transition a space where streaming has been enabled from Open to Secure or Secure to Open. |
No Format |
---|
{
"spaceId" : ""
} |
spaceId - Name of the space for which streaming is to be deleted |
No Format |
---|
{
"result" : ""
} |
result - Text indicating the results of the task |
get-url-hls | Get URL for HLS task | Retrieves a URL for a media file that is streamed through CloudFront via HLS |
No Format |
---|
{
"spaceId" : "",
"contentId" : "",
} |
spaceId - Name of the space in which the streamed content is stored contentId - Name of the content item to be streamed |
No Format |
---|
{
"streamUrl" : ""
} |
streamUrl - The URL to be used for streaming the requested content |
get-signed-cookies-url | Get Signed Cookies URL task | Generates a set of cookies to be set on the end-user's browser which will provide access to streams in a space with secure streaming enabled. Parameters provide ways to further limit access to streaming content. Rather than returning the cookies, this call stores them and returns a URL through which the cookies can be retrieved and set. |
No Format |
---|
{
"spaceId" : "",
"minutesToExpire" : "",
"ipAddress" : "",
"redirectUrl" : ""
} |
spaceId - Name of the space in which the streamed content is stored minutesToExpire - Number of minutes until the generated cookies expires and streams can no longer be played (optional, default is 480) ipAddress - IP address range where requests to stream must originate, in CIDR notation (e.g. 1.2.3.4/32) (optional) redirectUrl - The URL the user should be redirected to after visiting the signed cookies URL No Format |
---|
{
"signedCookiesUrl" : ""
} |
signedCookiesUrl - A URL to which the end user can be sent in order for signed cookies to be set in their browser |