View

This action will show information about transcode jobs

Tokens

This action requires the following tokens:

  • transcodejob-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
transcodejob Hash   If given, limit the output to only the transcode job with this hash
status String   Only show transcode jobs with specific statuses. Comma-separated list. Possible values are: queued, running, paused, resumerequested, pauserequested, completed, canceled, cancelrequested, and failed
mindatecreated DateTime   Only show transcode jobs that are created on or after this date/time
maxdatecreated DateTime   Only show transcode jobs that are created on or before this date/time
item Hash   Only show transcode jobs that belong to this file
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String created

Defines the field to order the results by; can be any of the following:

  • status – Order on status of the job
  • priority – Order on priority of the job
  • progress – Order on progress of the job
  • created – Order on when the job was created
  • started – Order on when the job was created
  • stopped – Order on when the job was created
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash ID of this transcode job
item

The item for which this transcode is done

The value of this field is an object containing the following fields:

Name Type Description
id Hash Item ID
title String Title of the item
description String Description of the item
type Label The type of this item; for available item types, refer to the documentation of the Item command
account

The account that created this item

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
datecreated DateTime When this item was created; for recordings of live-events, this is the date when the item finished recording
duration Duration Duration of this item
originalfilename String Original, human-readable name of the item
author String Author of the item
keywords

Keywords associated with this item, as an array

The value of this field is an array containing zero or more elements, each one being one String

copyright String Copyright notice of the item
externallink String A link to an external page, such as a page containing more information about this item, or the page where this item is embedded
externalid String An external ID which can be used by clients
protected Boolean True if signed links must be used to view this item, otherwise false
archived Boolean True if this item has been archived
securityprofile

Security profile

The value of this field is an object containing the following fields:

Name Type Description
id Hash Security profile ID
name String The name of this security profile
datemodified DateTime When this item was last modified
dateaired DateTime When this item was aired, e.g. on television
user

The user that created this item

The value of this field is an object containing the following fields:

Name Type Description
id Hash User ID
username String User name
views Integer The total number of views recorded for this item; this is equal to the number of plays as reported by the Statistics command
videoaspect Float The aspect ratio of the video in this item, if applicable; the value is a float such as 1.333333 for an aspect ratio of 4:3
thumbnails

Links to the thumbnails for this item. See Posters for details on the format

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
index Integer Index of the thumbnail
url String URL to this thumbnail
selectedthumbnail Integer Which thumbnail is the selected one
selectedthumbnailurl String URL of the currently selected thumbnail
moviestripsurl String URL of the moviestrips file
medialink

The URLs at which this item is available for streaming

The value of this field is an object containing the following fields:

Name Type Description
progressive String The URL at which this item can be streamed using progressive streaming
hls String The URL at which this item can be streamed using HTTP Live Streaming
dash String The URL at which this item can be streamed using MPEG-DASH
smooth String The URL at which this item can be streamed using Smooth Streaming
hds String The URL at which this item can be streamed using HTTP Dynamic Streaming
transcodestatus String The current status of transcodes for this item
transcodefailures String The current status of transcode failures for this item
isplayable Boolean Whether or not this item is playable through a standard embedframe at this moment
isbeingreplaced Boolean Whether or not this item is being replaced with a new source file at this moment
vrtype Label If this item is a virtual reality video, the type of virtual reality rendering to apply
itemfile

Source item file for this transcode

The value of this field is an object containing the following fields:

Name Type Description
id Hash ID of this item file
type String Type of this item file
originalfilename String Original, human-readable name of this file
extension String Extension of this file
size Integer File size in bytes
datecreated DateTime When this file was created
datemodified DateTime When this file was last modified
origin String Origin of this file
archived Boolean True if this item has been archived
deleted Boolean True if the item has been deleted
profile

The profile used to encode this file

The value of this field is an object containing the following fields:

Name Type Description
id Hash Unique identifier for the profile
name String Name of the profile
width Integer Width of the file in pixels (for video files)
height Integer Height of the file in pixels (for video files)
format String File format/container
audiocodec String Audio codec used in this file (for audio files)
audiocodecname String Name of the audio codec used in this file (for audio files)
audiocodecdescription String Description of the audio codec used in this file (for audio files)
audiochannels Integer Number of audio channels (for audio files)
audiobitrate Integer Audio bitrate in bits per second (for audio files)
audiosamplerate Integer Audio sampel rate in Hz (for audio files)
audiobitdepth Integer Number of bits per audio sample (for audio files)
videocodec String Video codec used in this file (for video files)
videocodecname String Name of the video codec used in this file (for video files)
videocodecdescription String Description of the video codec used in this file (for video files)
videocodecprofile Label Video codec profile used in this file (for video files)
videocodecprofilename String Name of the video codec profile used in this file (for video files)
videocodecprofilelevel Float Video codec profile used in this file (for video files)
videobitrate Integer Video bitrate in bits per second (for video files)
videoaspect Float Video aspect ratio (for video files)
videoframerate Float Video frame rate in frames per second (for video files)
videogoprate Integer Video group-of-frame rate: the number of frames between 2 consecutive keyframes (for video files)
videoisvbr Boolean True if the video has a variable bit rate, false if it has a constant bit rate (for video files)
videoisinterlaced Boolean True if the video is interlaced, false if it is progressive (for video files)
corrupted Boolean True if and only if this file is corrupted
rotation Integer Rotation of this video file (for video files)
medialink

The URLs at which this item file is available for streaming

The value of this field is an object containing the following fields:

Name Type Description
progressive String The URL at which this item file can be streamed using progressive streaming
hls String The URL at which this item file can be streamed using HTTP Live Streaming
dash String The URL at which this item file can be streamed using MPEG-DASH
smooth String The URL at which this item file can be streamed using Smooth Streaming
hds String The URL at which this item file can be streamed using HTTP Dynamic Streaming
profile

The transcode profile used

The value of this field is an object containing the following fields:

Name Type Description
id Hash ID of this transcode profile
name String Name of this transcode profile
defaultpriority String The default priority of transcode jobs created using this profile; one of idle, low, normal, high or realtime
account

If set, the account to which this profile is limited; if not set, this profile is available system-wide

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
itemtype Label Item type of the resulting file
width Integer Width of the resulting video in pixels. If this is -1 it will be calculated based on the dimensions of the video to transcode and the height of this profile
height Integer Height of the resulting video in pixels. If this is -1 it will be calculated based on the dimensions of the video to transcode and the width of this profile. Note that if this value is not -1, it will always be a multiple of 4 if this profile might output interlaced video
allowupscaling Boolean Whether to allow upscaling of video
audiocodec Label The audio codec used
audiochannels Integer The number of audio channels
audiobitrate Integer Audio bit rate in bits per second
audiobitdepth Integer Audio bit depth in bits per sample
audiosamplerate Integer Audio sample rate in Hz
videocodec Label The video codec used
videobitrate Integer Video bit rate in bits per second
videoframerate Float Video frame rate in frames per second
videoframeratemax Integer If set, maximum video frame rate in frames per second
itemfileformat Label If set, the item file format of this profile
videocodecprofile Label If set, the video codec profile to use
videogoprate Integer The video GoP / keyframe rate in frames per second
videogopratefactor Float The video GoP rate factor in seconds per GoP
usevbr Boolean Whether to use a variable bit rate
numpasses Integer Number of passes to perform; 1 or 2
sharpen Boolean Whether to sharpen the video
deinterlace Integer Whether to deinterlace the video. This field is here for backwards compatibility. Recommended is to use the ‘inputdeinterlacing’ field: possible values: 1 = deinterlace, 0 = keep, -1 = auto. See transcodeprofile for more information
inputdeinterlacing Label Whether to deinterlace the video; possible values are auto, deinterlace and keep. See transcodeprofile for more information
outputscantype Label The output scan type for videos created with this profile; possible values are auto, interlaced and progressive. See transcodeprofile for more information
bframemax Integer The maximum number of consecutive B-frames; 0 means no limit
bframestrategy Label Strategy to use for determining B-frames; either default or simple
scaletype String Scale type to use for this profile if both width and height are given. See transcodeprofile for more information
croptop Integer If set, number of pixels to crop off the top of the source video
cropbottom Integer If set, number of pixels to crop off the bottom of the source video
cropleft Integer If set, number of pixels to crop off the left of the source video
cropright Integer If set, number of pixels to crop off the right of the source video
deletesource Boolean Whether to delete the source item file after transcoding has completed successfully
overlayitemfile

The ItemFile we use as an overlay image

The value of this field is an object containing the following fields:

Name Type Description
id Hash ID of this item file
type String Type of this item file
originalfilename String Original, human-readable name of this file
extension String Extension of this file
size Integer File size in bytes
datecreated DateTime When this file was created
datemodified DateTime When this file was last modified
origin String Origin of this file
archived Boolean True if this item has been archived
deleted Boolean True if the item has been deleted
profile

The profile used to encode this file

The value of this field is an object containing the following fields:

Name Type Description
id Hash Unique identifier for the profile
name String Name of the profile
width Integer Width of the file in pixels (for video files)
height Integer Height of the file in pixels (for video files)
format String File format/container
audiocodec String Audio codec used in this file (for audio files)
audiocodecname String Name of the audio codec used in this file (for audio files)
audiocodecdescription String Description of the audio codec used in this file (for audio files)
audiochannels Integer Number of audio channels (for audio files)
audiobitrate Integer Audio bitrate in bits per second (for audio files)
audiosamplerate Integer Audio sampel rate in Hz (for audio files)
audiobitdepth Integer Number of bits per audio sample (for audio files)
videocodec String Video codec used in this file (for video files)
videocodecname String Name of the video codec used in this file (for video files)
videocodecdescription String Description of the video codec used in this file (for video files)
videocodecprofile Label Video codec profile used in this file (for video files)
videocodecprofilename String Name of the video codec profile used in this file (for video files)
videocodecprofilelevel Float Video codec profile used in this file (for video files)
videobitrate Integer Video bitrate in bits per second (for video files)
videoaspect Float Video aspect ratio (for video files)
videoframerate Float Video frame rate in frames per second (for video files)
videogoprate Integer Video group-of-frame rate: the number of frames between 2 consecutive keyframes (for video files)
videoisvbr Boolean True if the video has a variable bit rate, false if it has a constant bit rate (for video files)
videoisinterlaced Boolean True if the video is interlaced, false if it is progressive (for video files)
corrupted Boolean True if and only if this file is corrupted
rotation Integer Rotation of this video file (for video files)
medialink

The URLs at which this item file is available for streaming

The value of this field is an object containing the following fields:

Name Type Description
progressive String The URL at which this item file can be streamed using progressive streaming
hls String The URL at which this item file can be streamed using HTTP Live Streaming
dash String The URL at which this item file can be streamed using MPEG-DASH
smooth String The URL at which this item file can be streamed using Smooth Streaming
hds String The URL at which this item file can be streamed using HTTP Dynamic Streaming
overlayposition String Base position to use for the overlay image (tl/tr/bl/br/center)
overlayoffset Integer Overlay offset in whole percent (0-100)
overlayheight Integer Overlay height in whole percent (0-100)
qualitypreset String Quality preset of this profile as one of the QUALITY_PRESET_* constants
qualitytuning String Quality tuning of this profile as one of the QUALITY_TUNING_* constants
archive Boolean Whether to archive item files created with this profile
rotation String Rotation setting for this profile. auto = automatically detect and fix rotation from metadata. keepmetadata = do not rotate but keep metadata in output, rotate0/90/180/270 = force rotation by this amount of degrees
deletesource Boolean Whether to delete the source item file when the transcode job has completed
priority String The priority of this transcode job; can be idle, low, medium, high or realtime
status String The current status of this transcode job; can be queued, running, paused, completed, canceled or failed
progress Float The current progress of this job, as a floating point value between 0 (no processing done) and 1 (completed); is always 0 when the status is queued, and is always 1 when the status is completed, failed or canceled
datecreated DateTime When this transcode job has been created
datestarted DateTime If known, when this transcode job has been started; is always set if the current status is not queued
datecompleted DateTime If known, when this transcode job has completed; is always set if the current status is completed, canceled or failed
rotation String If known, the rotation to force for this transcode job. Can be rotate0/90/180/270

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_ITEM_NOT_FOUND (120)