FFmpeg::Stream::Audio - An audio stream from a (multi)media stream group.


FFmpeg documentation  | view source Contained in the FFmpeg distribution.

Index


NAME

Top

FFmpeg::Stream::Audio - An audio 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::Audio objects using methods in FFmpeg::StreamGroup. See FFmpeg::StreamGroup for more information.

This class represents an audio stream in a multimedia stream group, and has audio-specific attributes. 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())

channels()

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

Function

number of audio channels in this stream, if applicable

Returns

value of channels (a scalar)

Arguments

none, read-only

sample_format()

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

Function

??? FIXME

Returns

value of sample_format (a scalar)

Arguments

none, read-only

sample_rate()

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

Function

audio samples/second, or Hertz (Hz).

Returns

value of sample_rate (a scalar)

Arguments

none, read-only


FFmpeg documentation  | view source Contained in the FFmpeg distribution.