Code Index:

package FFmpeg::Stream::Audio
EOF

NAME

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

SYNOPSIS

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

DESCRIPTION

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

See FEEDBACK in FFmpeg for details.

AUTHOR

Allen Day <allenday@ucla.edu>

COPYRIGHT AND LICENSE

This library is released under GPL, the Gnu Public License

APPENDIX

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