GET StreamAuth.ashx?action={action}&token={token}&url={url}&online={online}&playbackType={playbackType}

Authorize Stream Playback

Request Information

URI Parameters

NameDescriptionTypeAdditional information
action

Play, Export, Burn (Only Play is supported)

string

Required

token

Cast Token

string

Required

url

Download URL (optional)

string

None.

online

boolean

None.

playbackType

Enums.PlaybackType

None.

Body Parameters

None.

Response Information

Resource Description

API.Models.StreamAuthResult
NameDescriptionTypeAdditional information
downloadURL

string

None.

posterURL

string

None.

keySystemOptions

Collection of API.Models.KeySystemOptions

None.

keySystems

Object

None.

errorCode

string

None.

errorMessage

string

None.

errorStackTrace

string

None.

errorActionCaption

string

None.

errorActionURL

string

None.

thumbnailURL

string

None.

videoInfoBaseURL

string

None.

videoInfo

Object

None.

contentType

Current content type (video, audio, book)

string

None.

fluxPlayer

boolean

None.

shortProjectID

integer

None.

projectID

string

None.

userToken

Required to store cloud data.

string

None.

sessionID

Required to update usage length for the current session

integer

None.

sessionInfo

Required to call 'store stream session info'

API.Models.StreamSessionInfos

None.

userData

Cloud data for current content and user.

API.Models.StreamAuthUserData

None.

bookInfo

Infos for PDF/EPub content

API.Models.StreamAuthBookInfo

None.

Response Formats

{
  "downloadURL": "sample string 1",
  "posterURL": "sample string 2",
  "keySystemOptions": [
    {
      "name": "sample string 1",
      "options": {
        "serverURL": "sample string 1"
      }
    },
    {
      "name": "sample string 1",
      "options": {
        "serverURL": "sample string 1"
      }
    }
  ],
  "keySystems": {},
  "errorCode": "sample string 4",
  "errorMessage": "sample string 5",
  "errorStackTrace": "sample string 6",
  "errorActionCaption": "sample string 7",
  "errorActionURL": "sample string 8",
  "thumbnailURL": "sample string 9",
  "videoInfoBaseURL": "sample string 10",
  "videoInfo": {},
  "contentType": "sample string 12",
  "fluxPlayer": true,
  "shortProjectID": 14,
  "projectID": "sample string 15",
  "userToken": "sample string 16",
  "sessionID": 17,
  "sessionInfo": {
    "licenseID": 1,
    "projectID": 2,
    "deviceID": 3,
    "runtime": 4,
    "date": "2024-06-13T10:23:54.7774663+02:00",
    "playbackType": "Web"
  },
  "userData": {
    "resumeBookmark": "sample string 1",
    "usageLength": 2
  },
  "bookInfo": {
    "print": true,
    "save": true,
    "select": true,
    "selectCount": 4,
    "remaningTime": 5.1,
    "fileName": "sample string 6",
    "encrypted": true,
    "length": 8,
    "key": "sample string 9",
    "iv": "sample string 10",
    "printLevel": 11,
    "lms": {
      "attempt": 1,
      "data": [
        {
          "key": "sample string 1",
          "value": "sample string 2",
          "path": "sample string 3"
        },
        {
          "key": "sample string 1",
          "value": "sample string 2",
          "path": "sample string 3"
        }
      ],
      "menu": [
        {
          "RootPath": "sample string 1",
          "Title": "sample string 2",
          "href": "sample string 3",
          "child": []
        },
        {
          "RootPath": "sample string 1",
          "Title": "sample string 2",
          "href": "sample string 3",
          "child": []
        }
      ],
      "rootPath": "sample string 2",
      "customerID": 3,
      "projectID": 4,
      "deviceID": 5,
      "streamingID": "sample string 6"
    }
  }
}