Editfile

Edit an item file

Currently it is only possible to (un)archive an item file

Tokens

This action requires the following tokens:

  • item-file-edit

Arguments

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

Argument Type Default Description
item Hash   The item to edit a file from
file Hash   The file to edit
archived Boolean   New archived status of the file

Output

This action produces the following output on success:

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

Errors

This action will always return one of the default status codes.