API: Timeshift

To take advantage of this account feature, Content Publishing must first be enabled within your 3Play Media account. 

See more information on Enabling Content Publishing.

Once Content Publishing is enabled, follow the instructions below to timeshift your file to compensate for a source file's new duration.

PLEASE NOTE:This will only work when content has been added or removed to the BEGINNING or END of your media file. This WILL NOT work for an edit made in the middle of the source material.   If edits have been made to the middle of the video, you can follow the Advanced Timeshift API document, to edit caption files.

 IMPORTANT NOTE: Timeshifts are only applied to the version of your file that is opened in a new web browser via a publishing link ( as detailed in steps 4-6). Once a timeshift is applied, the altered file can then be downloaded to your computer however the timeshift is not applied permanently to the file stored in the 3Play Media account system. 

 

Step 1- Click your file

Once logged into your account, click on the file's name to open the file show page.

Select transcript

Step 2- Click Quick Link

Click the Quick Link icon.

Captions Publish link

 

Step 3- Select format

From the drop down menu that appears select from one of your Favorite Formats.

Caption Transcript format select

If you have yet to configure this setting the drop down menu will contain an option to navigate to this project setting. Once saved, the Favorite Formats will be the default choices when either Quick Download or Quick Link is clicked. 
Favorite Formats can be edited at any time.

 

Step 4- Open the file in a new window

Click on the link to your file and it will open in a new browser window in the format that was selected in step 3.

SCC caption format link

Step 5- Modify the URL

Remove "format_ID=(number of the format)"

For this step, please note:

The values used for offset= in this step are for demonstrative purposes.
The values you add for your offset will be unique to the edits made to your content.

Time can be added to offset a file using either seconds, milliseconds, or minutes:seconds.

Seconds
Offset in seconds: 10s would be an offset of 10 seconds. -10s would be an offset in the negative direction making the captions begin 10 seconds earlier. For this to work an "s" must be added after the value. 

You can also use tenths of seconds for a more precise shift. For example, 14.5s or 1.7s are acceptable values.

Milliseconds
Offset in milliseconds4200 would be an offset equaling 4.2 seconds. -4200 would be an offset in the negative direction making captions begin 4.2 seconds earlier. 
For this to work simply add a number value.
"ms" should not be added.

Minutes:seconds
Offset in minutes:seconds: 01:22 would be an offset equaling 1 minute and 22 seconds. -01:22 would be an offset in the negative direction making captions begin one minute and twenty-two seconds earlier. 

To make your captions start later add a value at the end of the URL.

Add:

&offset=30s

...to the end of the captions' URL. This modification must be added after the file format extension.

The example above will offset your captions making them start 30 seconds later

To make your captions start earlier add a negative value in seconds similar to the example below.

Add:

&offset=-12s

 

...to the end of the captions' URL. This modification must be added after the file format extension.

The example above will offset your captions making them start 12 seconds earlier.

Please note:  Offsets in the negative direction can inadvertently remove text from the beginning of your transcript but that shifting over the API does not permanently timeshift the file that is stored in your account. 
Only the the version being viewed/manipulated in the open window is affected.

Below is an example of what your URL should look similar to once it has been modified.

Once you have added the desired offset, click Enter/Return to apply this offset. 

Step 6- Adjusting Start and End Times

Additionally, you can modify the start and end times of the caption file.

For this step, please note:

The values used for startend, and offset in this step are for demonstrative purposes.
The values you add for these parameters will be unique to your specs.

https://account.3pmstaging.com/files/296217/captions.srt?start=5:00&end=6:00

 

Step 7- Download the file with offset

After clicking Enter/Return on your keyboard to apply the offset...

Add:

&dl=1

to the URL after the offset value. Click Enter/Return again and the offset file will download to your computer.

Here is an example of a modified URL that includes the offset value and the call to download the file.

dl1OffsetAPI.jpg

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk