Welcome Apps REST API

App Processing Settings

Below you can learn about the variety of processing options you have for every asset uploaded to your account.

Processing Settings
Videos
Images
Filmstrips
Audio
Waveforms
Captions

Videos

For any Video input (usually from the <camera> tag) you can choose to have the CameraTag transcoding farm generate a video output. For each video output you create you may customize:

  • The Media Name: This is a unique name uned to identify this particular output from the others (for example: "720p_with_company_watermak"). Note that because media names are used in URLs and JSON names must not conatin special characters or spaces.

  • Resolution: This field allows you to specify the resolution of the video being generated. We have some predefined values setup for you (QVGA, VGA, 720p etc.) but you may also choose custom resolutions (if the apsect ratio differs from the original, the video will be padded to fit).

  • Max Length: This field allows you to specify the maximum length (in seconds) of the video file generated. This will automatically crop any sources longer than the specified length.

  • Extension: This field allows you to define the extension (and in-turn the codec) of the generated file. For videos the current options are mp4, webm, and m3u8 (HLS).

  • Overlay: You may optionally overlay an image on the generated video (think watermark or lower third). Simply provide a URL, width, height, top and left position for the image (you may position elemets in the lower right corner by using negative numbers in the top and left fields). Additionally you may use percentages in the height and width fields.

Images

For any Video or Photo input (usually from the <camera> tag or %ltphotobooth> tag) you can choose to have the CameraTag transcoding farm generate an image (thumbnail) output. For each image output you create you may customize:

  • The Media Name: This is a unique name uned to identify this particular output from the others (for example: "half_size_thumb_with_watermark"). Note that because media names are used in URLs and JSON names must not conatin special characters or spaces.

  • Resolution: This field allows you to specify the resolution of the image being generated. If the apsect ratio differs from the source media, the image will be padded to fit (black bars).

  • Offset: If the source media is a Video this parameter will allow you to define from what point in the video the thumbnal should be taken. This value can be given as a number of seconds or a percentage.

  • Extension: This field allows you to define the extension (and in-turn the codec) of the generated image. For images the current options are jpg and png.

  • Overlay: You may optionally overlay an image on the generated image (think watermark or lower third). Simply provide a URL, width, height, top and left position for the image (you may position elemets in the lower right corner by using negative numbers in the top and left fields). Additionally you may use percentages in the height and width fields of the overlay.

Images

For any Video or Photo input (usually from the <camera> tag or %ltphotobooth> tag) you can choose to have the CameraTag transcoding farm generate an image (thumbnail) output. For each image output you create you may customize:

  • The Media Name: This is a unique name uned to identify this particular output from the others (for example: "half_size_thumb_with_watermark"). Note that because media names are used in URLs and JSON names must not conatin special characters or spaces.

  • Width & Height: These fields allows you to specify the resolution of the image being generated. If the apsect ratio differs from the source media, the image will be padded to fit (black bars).

  • Offset: If the source media is a Video this parameter will allow you to define from what point in the video the thumbnal should be taken. This value can be given as a number of seconds or a percentage.

  • Extension: This field allows you to define the extension (and in-turn the codec) of the generated image. For images the current options are jpg and png.

  • Overlay: You may optionally overlay an image on the generated image (think watermark or lower third). Simply provide a URL, width, height, top and left position for the image (you may position elemets in the lower right corner by using negative numbers in the top and left fields). Additionally you may use percentages in the height and width fields of the overlay.

Filmstrips

For any Video input (usually from the <camera>) you can choose to have the CameraTag transcoding farm generate a filmstrip output. For each filmstrip you create you may customize:

  • The Media Name: This is a unique name uned to identify this particular output from the others (for example: "filmstrip"). Note that because media names are used in URLs and JSON names must not conatin special characters or spaces.

  • Resolution: All filmstrips have a fixed 300px width. Their height is dictated by the aspect ratio of the source media which you can define using the filmstrip's height and width parameters.

  • Extension: This field allows you to define the extension (and in-turn the codec) of the generated image. For filmstrps the current options are jpg and png.

  • Overlay: You may optionally overlay an image on the generated thumbnail (think watermark or lower third). This overlay will be placed on each frame of the filmstrip. Simply provide a URL, width, height, top and left position for the image (you may position elemets in the lower right corner by using negative numbers in the top and left fields). Additionally you may use percentages in the height and width fields of the overlay.

Audio

For any Video or Audio input (usually from the <camera> tag or %microphone> tag) you can choose to have the CameraTag transcoding farm generate an audio output. For each audio output you create you may customize:

  • The Media Name: This is a unique name uned to identify this particular output from the others (for example: "mp3_audio_track"). Note that because media names are used in URLs and JSON names must not conatin special characters or spaces.

  • Max Length: This field allows you to specify the maximum length (in seconds) of the audio file generated. This will automatically crop any sources longer than the specified length.

  • Extension: This field allows you to define the extension (and in-turn the codec) of the generated image. For images the current options are mp3, wav and aiff.

Waveforms

For any Video or Audio input (usually from the <camera> tag or %microphone> tag) you can choose to have the CameraTag transcoding farm generate an waveform output. This is a visual representation of the audio's waveform in image form. For each waveform output you create you may customize:

  • The Media Name: This is a unique name uned to identify this particular output from the others (for example: "mp3_audio_track"). Note that because media names are used in URLs and JSON names must not conatin special characters or spaces.

  • Waveform Color: This field allows you to choose the color of the weveform in the image (defined as an HTML hex value, for example #ff0000)

  • Width & Height: These fields allows you to specify the resolution of the waveform image being generated (in pixels)

  • Extension: This field allows you to define the extension (and in-turn the codec) of the generated image. For images the current options are mp3, wav and aiff.

Captions

For any Video or Audio input (usually from the <camera> tag or %microphone> tag) you can choose to have the CameraTag transcoding farm generate text cpations of the audio stream. This create a VTT formatted text file containing the words and timestamps of spoken words in the audio stream. These captions will automatically be made available as a captions overlay in the CameraTag player (audio and/or video assets). To create a transcription all you have to do is provide a media name and a language to detect:

  • The Media Name: This is a unique name uned to identify this particular output from the others (for example: "en_captions"). Note that because media names are used in URLs and JSON names must not conatin special characters or spaces.

  • Language: What language should we listen for / transcribe? The supported langages are:
    • English (US)
    • English (UK)
    • French
    • Spanish (ES)
    • Chineese (ZH)
    • Portuguese (BR)
    • Arabic