GET v1/texttracks/edit/{id}/load

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

CaptionEditorLoadResponse
NameDescriptionTypeAdditional information
MediaUrl

string

None.

ThumbnailUrl

string

None.

MediaType

string

None.

AspectRatio

string

None.

CaptionTracks

Collection of CaptionEditorCaptionTrack

None.

captionType

string

None.

publishEndpoint

string

None.

ProjectName

string

None.

FrameRate

decimal number

None.

DropFrame

boolean

None.

promptToRetranslate

boolean

None.

StyleGuides

Collection of CaptionEditorStyleGuide

None.

Response Formats

application/json, text/json

Sample:
{
  "mediaUrl": "sample string 1",
  "thumbnailUrl": "sample string 2",
  "mediaType": "sample string 3",
  "aspectRatio": "sample string 4",
  "captionTracks": [
    {
      "language": "sample string 1",
      "url": "sample string 2",
      "type": "sample string 3",
      "maxChars": 4,
      "maxLines": 5,
      "overlaps": true,
      "illegalChars": true
    },
    {
      "language": "sample string 1",
      "url": "sample string 2",
      "type": "sample string 3",
      "maxChars": 4,
      "maxLines": 5,
      "overlaps": true,
      "illegalChars": true
    }
  ],
  "captionType": "sample string 5",
  "publishEndpoint": "sample string 6",
  "projectName": "sample string 7",
  "frameRate": 8.1,
  "dropFrame": true,
  "promptToRetranslate": true,
  "styleGuides": [
    {
      "name": "sample string 1",
      "minDuration": 2.1,
      "maxDuration": 3.1,
      "maxChars": 4,
      "maxLines": 5,
      "overlaps": true,
      "illegalChars": true
    },
    {
      "name": "sample string 1",
      "minDuration": 2.1,
      "maxDuration": 3.1,
      "maxChars": 4,
      "maxLines": 5,
      "overlaps": true,
      "illegalChars": true
    }
  ]
}

application/xml, text/xml

Sample:
<CaptionEditorLoadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CablecastAPI.Controllers.api.v1">
  <AspectRatio>sample string 4</AspectRatio>
  <CaptionTracks>
    <CaptionEditorCaptionTrack>
      <IllegalChars>true</IllegalChars>
      <Language>sample string 1</Language>
      <MaxChars>4</MaxChars>
      <Overlaps>true</Overlaps>
      <Type>sample string 3</Type>
      <Url>sample string 2</Url>
      <maxLines>5</maxLines>
    </CaptionEditorCaptionTrack>
    <CaptionEditorCaptionTrack>
      <IllegalChars>true</IllegalChars>
      <Language>sample string 1</Language>
      <MaxChars>4</MaxChars>
      <Overlaps>true</Overlaps>
      <Type>sample string 3</Type>
      <Url>sample string 2</Url>
      <maxLines>5</maxLines>
    </CaptionEditorCaptionTrack>
  </CaptionTracks>
  <DropFrame>true</DropFrame>
  <FrameRate>8.1</FrameRate>
  <MediaType>sample string 3</MediaType>
  <MediaUrl>sample string 1</MediaUrl>
  <ProjectName>sample string 7</ProjectName>
  <StyleGuides>
    <CaptionEditorStyleGuide>
      <IllegalChars>true</IllegalChars>
      <MaxChars>4</MaxChars>
      <MaxDuration>3.1</MaxDuration>
      <MaxLines>5</MaxLines>
      <MinDuration>2.1</MinDuration>
      <Name>sample string 1</Name>
      <Overlaps>true</Overlaps>
    </CaptionEditorStyleGuide>
    <CaptionEditorStyleGuide>
      <IllegalChars>true</IllegalChars>
      <MaxChars>4</MaxChars>
      <MaxDuration>3.1</MaxDuration>
      <MaxLines>5</MaxLines>
      <MinDuration>2.1</MinDuration>
      <Name>sample string 1</Name>
      <Overlaps>true</Overlaps>
    </CaptionEditorStyleGuide>
  </StyleGuides>
  <ThumbnailUrl>sample string 2</ThumbnailUrl>
  <captionType>sample string 5</captionType>
  <promptToRetranslate>true</promptToRetranslate>
  <publishEndpoint>sample string 6</publishEndpoint>
</CaptionEditorLoadResponse>