1. trait
  2. Cloudinary
  3. \
  4. Transformation
  5. \
  6. VideoSpecificTransformationTrait

VideoSpecificTransformationTrait

trait VideoSpecificTransformationTrait

Trait VideoSpecificTransformationTrait

Methods

noStream()

Don't stream a video that is currently being generated on the fly. Wait until the video is fully generated.

streamingAttachment(string $filename = null)

Causes the video download to begin immediately, streaming it as a fragmented video file.

hlsv3()

Deliver an HLS adaptive bitrate streaming file as HLS v3 instead of the default version (HLS v4).

keepDar()

Keep the Display Aspect Ratio metadata of the uploaded video.

mono()

Convert the audio channel to mono.

truncateTS()

Truncate (trim) a video file based on the start time defined in the metadata.

waveform()

Create a waveform image (in the format specified by the file extension) from the audio or video file.

trim(Timeline $range)

Trims a video (and discards the rest).

roundCorners(int|string $radius)

Rounds the corners of a video.

overlay(BaseSource|string $videoLayer, BasePosition|null $position = null, Timeline|null $timeline = null)

Adds another video, text, image as an overlay over the container video.

concatenate(VideoSource|string $videoSource)

Concatenates another video or image.

cutter(VideoSource|string $videoLayer, BasePosition|null $position = null, Timeline|null $timeline = null)

Applies the video as a cutter for the main video.

addSubtitles(string $subtitlesId)

Adds subtitles to the video.

transcode(AudioCodec|VideoCodec|AudioFrequency|mixed $transcode)

Transcodes the video (or audio) to another format / adjusts encoding properties.

fps(float|int|string $min, float|int|string|null $max = null)

Controls the range of acceptable FPS (Frames Per Second) to ensure that video (even when optimized) is delivered with an expected fps level (helps with sync to audio).

keyframeInterval(float $interval)

Explicitly sets the keyframe interval of the delivered video.

bitRate(int|string $bitRate, string $type = null)

Controls the video bitrate.

streamingProfile(string $streamingProfile)

Sets the streaming profile to apply to an HLS or MPEG-DASH adaptive bitrate streaming video.

videoSampling(int|string $value)

Sets the total number of frames to sample from the original video.

videoEdit(mixed $videoEdit)

Applies the specified video edit action.

Details

VideoTransformationFlagTrait noStream()

Don't stream a video that is currently being generated on the fly. Wait until the video is fully generated.

Return Value

VideoTransformationFlagTrait

VideoTransformationFlagTrait streamingAttachment(string $filename = null)

Causes the video download to begin immediately, streaming it as a fragmented video file.

Parameters

Name Type Description
$filename string The attachment's filename

Return Value

VideoTransformationFlagTrait

See also

Flag::streamingAttachment

VideoTransformationFlagTrait hlsv3()

Deliver an HLS adaptive bitrate streaming file as HLS v3 instead of the default version (HLS v4).

Return Value

VideoTransformationFlagTrait

See also

Flag::hlsv3

VideoTransformationFlagTrait keepDar()

Keep the Display Aspect Ratio metadata of the uploaded video.

Return Value

VideoTransformationFlagTrait

VideoTransformationFlagTrait mono()

Convert the audio channel to mono.

Return Value

VideoTransformationFlagTrait

VideoTransformationFlagTrait truncateTS()

Truncate (trim) a video file based on the start time defined in the metadata.

Return Value

VideoTransformationFlagTrait

VideoTransformationFlagTrait waveform()

Create a waveform image (in the format specified by the file extension) from the audio or video file.

Return Value

VideoTransformationFlagTrait

VideoSpecificTransformationTrait trim(Timeline $range)

Trims a video (and discards the rest).

Parameters

Name Type Description
$range Timeline Specify the range of the video to leave.

Return Value

VideoSpecificTransformationTrait

See also

https://cloudinary.com/documentation/video_manipulation_and_delivery#trimming_videos

VideoSpecificTransformationTrait roundCorners(int|string $radius)

Rounds the corners of a video.

Parameters

Name Type Description
$radius int|string The radius of the corners in pixels.

Return Value

VideoSpecificTransformationTrait

See also

https://cloudinary.com/documentation/video_manipulation_and_delivery#rounding_corners_and_creating_circular_videos

VideoSpecificTransformationTrait overlay(BaseSource|string $videoLayer, BasePosition|null $position = null, Timeline|null $timeline = null)

Adds another video, text, image as an overlay over the container video.

Parameters

Name Type Description
$videoLayer BaseSource|string The overlay.
$position BasePosition|null The position of the overlay.
$timeline Timeline|null The timeline position of the overlay.

Return Value

VideoSpecificTransformationTrait

See also

https://cloudinary.com/documentation/video_manipulation_and_delivery#adding_video_overlays

VideoSpecificTransformationTrait concatenate(VideoSource|string $videoSource)

Concatenates another video or image.

Parameters

Name Type Description
$videoSource VideoSource|string The source of the video to concatenate.

Return Value

VideoSpecificTransformationTrait

See also

https://cloudinary.com/documentation/video_manipulation_and_delivery#concatenating_videos

VideoSpecificTransformationTrait cutter(VideoSource|string $videoLayer, BasePosition|null $position = null, Timeline|null $timeline = null)

Applies the video as a cutter for the main video.

Parameters

Name Type Description
$videoLayer VideoSource|string The cutter video layer.
$position BasePosition|null The position of the cutter.
$timeline Timeline|null The timeline position of the cutter.

Return Value

VideoSpecificTransformationTrait

VideoSpecificTransformationTrait addSubtitles(string $subtitlesId)

Adds subtitles to the video.

Parameters

Name Type Description
$subtitlesId string The subtitles file public ID.

Return Value

VideoSpecificTransformationTrait

VideoSpecificTransformationTrait transcode(AudioCodec|VideoCodec|AudioFrequency|mixed $transcode)

Transcodes the video (or audio) to another format / adjusts encoding properties.

Parameters

Name Type Description
$transcode AudioCodec|VideoCodec|AudioFrequency|mixed The new format or encoding property.

Return Value

VideoSpecificTransformationTrait

VideoSpecificTransformationTrait fps(float|int|string $min, float|int|string|null $max = null)

Controls the range of acceptable FPS (Frames Per Second) to ensure that video (even when optimized) is delivered with an expected fps level (helps with sync to audio).

Parameters

Name Type Description
$min float|int|string The minimum frame rate.
$max float|int|string|null The maximum frame rate.

Return Value

VideoSpecificTransformationTrait

VideoSpecificTransformationTrait keyframeInterval(float $interval)

Explicitly sets the keyframe interval of the delivered video.

Parameters

Name Type Description
$interval float Positive float number in seconds.

Return Value

VideoSpecificTransformationTrait

VideoSpecificTransformationTrait bitRate(int|string $bitRate, string $type = null)

Controls the video bitrate.

Parameters

Name Type Description
$bitRate int|string The number of bits used to represent the video data per second. By default the video uses a variable bitrate (VBR), with this value indicating the maximum bitrate. Can be an integer e.g. 120000, or a string supporting "k" and "m" (kilobits and megabits respectively) e.g. 250k or 2m.
$type string The type of bitrate. If "constant" is specified, the video plays with a constant bitrate (CBR). Use the constant defined in the BitRate class.

Return Value

VideoSpecificTransformationTrait

VideoSpecificTransformationTrait streamingProfile(string $streamingProfile)

Sets the streaming profile to apply to an HLS or MPEG-DASH adaptive bitrate streaming video.

The value can be one of the pre-defined streaming profiles or a custom-defined one. You can use the streaming profiles methods of StreamingProfilesTrait to get a list of the available streaming profiles or to create new custom profiles.

Parameters

Name Type Description
$streamingProfile string The streaming profile.

Return Value

VideoSpecificTransformationTrait

See also

https://cloudinary.com/documentation/video_manipulation_and_delivery#predefined_streaming_profiles
StreamingProfilesTrait

VideoSpecificTransformationTrait videoSampling(int|string $value)

Sets the total number of frames to sample from the original video.

Relevant when converting videos to animated GIF or WebP format. If not specified, the resulting GIF or WebP samples the whole video (up to 400 frames, at up to 10 frames per second). By default the duration of the animated image is the same as the duration of the video, no matter how many frames are sampled from the original video (use the delay qualifier to adjust the amount of time between frames).

Parameters

Name Type Description
$value int|string Integer - The total number of frames to sample from the original video. The frames are spread out over the length of the video, e.g. 20 takes one frame every 5%. String - The number of seconds between each frame to sample from the original video. e.g. 2.3s takes one frame every 2.3 seconds.

Return Value

VideoSpecificTransformationTrait

VideoSpecificTransformationTrait videoEdit(mixed $videoEdit)

Applies the specified video edit action.

Parameters

Name Type Description
$videoEdit mixed The video edit action.

Return Value

VideoSpecificTransformationTrait