FFmpeg::Stream::Video - A video stream from a (multi)media stream group.


FFmpeg documentation  | view source Contained in the FFmpeg distribution.

Index


NAME

Top

FFmpeg::Stream::Video - A video stream from a (multi)media stream group.

SYNOPSIS

Top

  $ff = FFmpeg->new();             #see FFmpeg
  #...
  $sg = $ff->create_streamgroup(); #see FFmpeg
  $st = ($sg->streams())[0];       #this is a FFmpeg::Stream

DESCRIPTION

Top

Objects of this class are not intended to be instantiated directly by the end user. Access FFmpeg::Stream::Video objects using methods in FFmpeg::StreamGroup. See FFmpeg::StreamGroup for more information.

This class represents a video stream in a multimedia stream group. General stream attributes can be found in the FFmpeg::Stream class.

FEEDBACK

Top

See FEEDBACK in FFmpeg for details.

AUTHOR

Top

Allen Day <allenday@ucla.edu>

COPYRIGHT AND LICENSE

Top

APPENDIX

Top

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a '_'. Methods are in alphabetical order for the most part.

new()

This class inherits from FFmpeg::Stream. See FFmpeg::Stream/new() (FFmpeg::Stream::new())

init()

This class inherits from FFmpeg::Stream. See FFmpeg::Stream/init() (FFmpeg::Stream::init())

video_rate()

Usage
 $obj->video_rate();        #get existing value

Function

video rate (frame rate) in frames/second. this only applies to video streams

Returns

value of video_rate (a scalar)

Arguments

none, read-only

height()

Usage
  $obj->height(); #get existing value

Function

height of the stream, in pixels

Returns

value of height (a scalar)

Arguments

none, read-only

quality()

Usage
  $obj->quality(); #get existing value

Function

stores a quantitative metric of the video codec "encoding quality". this is not comparable between different codecs.

Returns

value of quality (a scalar)

Arguments

none, read-only

width()

Usage
  $obj->width(); #get existing value

Function

width of the stream, in pixels

Returns

value of width (a scalar)

Arguments

none, read-only


FFmpeg documentation  | view source Contained in the FFmpeg distribution.