vod_clip_to_param_name

The `vod_clip_to_param_name` directive specifies a request parameter that determines the range of video content to be clipped from a source file during video packaging.

Syntaxvod_clip_to_param_name parameter_name;
Defaultnone
Contexthttp, server, location
Arguments1

Description

The vod_clip_to_param_name directive is part of the NGINX-based VOD Packager module and allows users to define a parameter name in the HTTP request that specifies where to clip the video content when packaging. This directive is particularly useful for serving video-on-demand (VOD) services where a precise segment of a video file is required based on user requests. By utilizing this parameter, VOD providers can offer customized video playback experiences, such as allowing users to start playback at a specific time in a video.

When configured within an http, server, or location block, the directive expects a single argument that represents the name of the query parameter that contains the clip position in the request. For example, if the user requests a video URL with a parameter like ?start=60, the directive can direct the system to start video playback at the specified timestamp of 60 seconds. This functionality supports applications such as streaming services and educational platforms where time-specific content delivery enhances user engagement.

It is important to handle the specified parameter correctly in the context of video packaging. The backend implementation will rely on proper parsing of the parameter to fetch and deliver the correct content segment, ensuring that the video is clipped accurately according to user demands.

Config Example

location /video {
    vod_clip_to_param_name start;
}

Ensure the provided parameter name matches exactly with the query parameter in the request.

If not set, the directive will default to none, which means clipping will not occur.

This directive should not conflict with other query parameter handlers in the location block.

← Back to all directives