Index
Code Index:
NAME
FFmpeg::ImageFormat - Image formats supported by FFmpeg's image codecs.
SYNOPSIS
$ff = FFmpeg->new(); #see FFmpeg
$if = $ff->image_format('jpeg');
#...do something with $if
DESCRIPTION
Objects of this class are not intended to be instantiated directly by the end user. Access FFmpeg::ImageFormat objects using image_format() in FFmpeg or image_formats() in FFmpeg.
Instances of this class represent a image formats supported by FFmpeg-C. If an image format exists, it means that FFmpeg-C can use it to do at least one of:
- convert a series of images of that type into a video stream
- convert a video stream into a series of images of that type
Call can_read() and can_write() to see what functionality is supported for a given image format.
FEEDBACK
See FEEDBACK in FFmpeg for details.
AUTHOR
Allen Day <allenday@ucla.edu>
COPYRIGHT AND LICENSE
Copyright (c) 2003-2004 Allen Day
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()
- Usage
-
my $obj = new FFmpeg::ImageFormat();
- Function
-
Builds a new FFmpeg::ImageFormat object
- Returns
-
an instance of FFmpeg::ImageFormat
- Arguments
-
All optional, refer to the documentation of new() in FFmpeg, this constructor operates in the same way.
init()
- Usage
-
$obj->init(%arg);
- Function
-
Internal method to initialize a new FFmpeg::ImageFormat object
- Returns
-
true on success
- Arguments
-
Arguments passed to new
can_read()
- Usage
-
$obj->can_read(); #get existing value
- Function
-
FFmpeg-C can use this format for input?
- Returns
-
a boolean
- Arguments
-
none, read-only
can_write()
- Usage
-
$obj->can_write(); #get existing value
- Function
-
FFmpeg-C can use this format for output?
- Returns
-
a boolean
- Arguments
-
none, read-only
name()
- Usage
-
$obj->name(); #get existing value
- Function
-
image format's name
- Returns
-
value of name (a scalar)
- Arguments
-
none, read-only