UNPKG

@cloudinary/url-gen

Version:

Cloudinary URL-Gen SDK ========================= [![Build Status](https://api.travis-ci.com/cloudinary/js-url-gen.svg?branch=master)](https://app.travis-ci.com/github/cloudinary/js-url-gen) ## About The Cloudinary URL-Gen SDK allows you to quickly and eas

127 lines (123 loc) 4.42 kB
'use strict'; var TrimAction = require('./TrimAction-28d60e57.cjs'); var ConcatenateAction = require('./ConcatenateAction-befc85c0.cjs'); var VolumeAction = require('./VolumeAction-17cb965f.cjs'); var PreviewAction = require('./PreviewAction-d846fde2.cjs'); /** * @summary action * @description Methods for editing a video. * * <b>Learn more:</b> {@link https://cloudinary.com/documentation/video_manipulation_and_delivery|Video manipulation} * @memberOf Actions * @namespace VideoEdit * @example * See the examples under every method */ /** * @summary action * @description Concatenates another video. * * <b>Learn more</b>: {@link https://cloudinary.com/documentation/video_trimming_and_concatenating#concatenating_media|Concatenating videos} * * @memberOf Actions.VideoEdit * @param {VideoSource} source The source to concatenate. * @return {Actions.VideoEdit.ConcatenateAction} * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {concatenate} from "@cloudinary/url-gen/actions/videoEdit"; * import {videoSource as concatVideoSource} from "@cloudinary/url-gen/qualifiers/concatenate"; * import {videoSource as tVideoSource} from "@cloudinary/url-gen/qualifiers/transition.js"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); * * video.videoEdit( concatenate(concatVideoSource('butterfly')) * .transition(tVideoSource('myTransition')) * .duration(5) * ) */ function concatenate(source) { return new ConcatenateAction.ConcatenateAction(source); } /** * @summary action * @description Trims a video (and discards the rest). * * <b>Learn more</b>: {@link https://cloudinary.com/documentation/video_trimming_and_concatenating#trimming_videos| * Trimming videos} * * @memberOf Actions.VideoEdit * @return {Actions.VideoEdit.TrimAction} * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {trim} from "@cloudinary/url-gen/actions/videoEdit"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); * * video.videoEdit( trim() * .startOffset(3) * .endOffset(4) * .duration(10) * ) */ function trim() { return new TrimAction.TrimAction(); } /** * @summary action * @description Increases or decreases the volume by a percentage of the current volume. * * <b>Learn more</b>: {@link https://cloudinary.com/documentation/audio_transformations#adjust_the_audio_volume| * Adjust the audio volume} * * @memberOf Actions.VideoEdit * @param {string | number} volumeValue The value of volume. The percentage change of volume (Range: -100 to 400). * For a list of supported types see {@link Qualifiers.Volume| Volume values} * @return {Actions.VideoEdit.VolumeAction} * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {volume} from "@cloudinary/url-gen/actions/videoEdit"; * import {mute} from '@cloudinary/url-gen/qualifiers/volume'; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); * * video.videoEdit( volume(10) ) // as percent * video.videoEdit( volume('5db') ) // as decibels * video.videoEdit( volume(mute()) ) // if you prefer silence.. */ function volume(volumeValue) { return new VolumeAction.VolumeAction(volumeValue); } /** * @summary action * @description A video preview is a short excerpt from a video that can be used to engage your audience and help them select the video content that interests them. * * <b>Learn more</b>: {@link https://cloudinary.com/documentation/video_effects_and_enhancements#ai_based_video_preview| * Create a video preview} * * @memberOf Actions.VideoEdit * @return {Actions.VideoEdit.PreviewAction} * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {preview} from "@cloudinary/url-gen/actions/videoEdit"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); * * video.videoEdit( preview() * .duration(5) * .minimumSegmentDuration(1) * .maximumSegments(10) * ) */ function preview() { return new PreviewAction.PreviewAction(); } const VideoEdit = { concatenate, trim, volume, preview }; exports.VideoEdit = VideoEdit; exports.concatenate = concatenate; exports.preview = preview; exports.trim = trim; exports.volume = volume;