Package com.avpkit.core

Class Configuration

java.lang.Object

com.avpkit.core.Configuration

public class Configuration
extends java.lang.Object

A global configuration class for AVPKit.

This object can help print setting options on IConfigurable classes, and also provides a convenient method configure(Properties, IConfigurable) that lets you configure IConfigurable objects from a Java properties or FFmpeg preset file.

Author:

aclarke

See Also:

configure(Properties, IConfigurable), IConfigurable

Method Summary

Modifier and Type	Method	Description
static int	configure(java.lang.String file, IConfigurable config)	Configures an IConfigurable from a file.
static int	configure(java.util.Properties properties, IConfigurable config)	Configures an IConfigurable from a set of Java Properties.
static void	main(java.lang.String[] args)	A main program that just prints information on all avaiable AVPKit options.
static void	printConfigurable(java.io.PrintStream stream, IConfigurable configObj)	Print out all configurable options on the IConfigurable object.
static void	printHelp(java.io.PrintStream stream)	Print out help about this AVPKit installation.
static void	printOption(java.io.PrintStream stream, IConfigurable configObj, IProperty prop)	Print information about the property on the configurable object.
static void	printSupportedCodecs(java.io.PrintStream stream)	Print out all installed and supported codecs on this system.
static void	printSupportedContainerFormats(java.io.PrintStream stream)	Print out all installed and supported container formats on this system.
static void	printSupportedContainerProperties(java.io.PrintStream stream)	Print out all IContainer supported properties.
static void	printSupportedStreamCoderProperties(java.io.PrintStream stream)	Print out all IStreamCoder supported properties.
static void	printSupportedVideoResamplerProperties(java.io.PrintStream stream)	Print out all IVideoResampler supported properties, if that option is supported in this version of AVPKit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

main

public static void main(java.lang.String[] args)

A main program that just prints information on all avaiable AVPKit options.

Parameters:

args - ignored

printHelp

public static void printHelp(java.io.PrintStream stream)

Print out help about this AVPKit installation. Specifically all installed and supported container formats, installed and supported codecs, all IContainer options, all IStreamCoder options and all IVideoResampler options.

Parameters:

stream - stream to print to

printSupportedContainerFormats

public static void printSupportedContainerFormats(java.io.PrintStream stream)

Print out all installed and supported container formats on this system.

Parameters:

stream - stream to print to

printSupportedCodecs

public static void printSupportedCodecs(java.io.PrintStream stream)

Print out all installed and supported codecs on this system.

Parameters:

stream - stream to print to

printSupportedVideoResamplerProperties

public static void printSupportedVideoResamplerProperties(java.io.PrintStream stream)

Print out all IVideoResampler supported properties, if that option is supported in this version of AVPKit.

Parameters:

stream - stream to print to.

printSupportedStreamCoderProperties

public static void printSupportedStreamCoderProperties(java.io.PrintStream stream)

Print out all IStreamCoder supported properties.

Parameters:

stream - stream to print to.

printSupportedContainerProperties

public static void printSupportedContainerProperties(java.io.PrintStream stream)

Print out all IContainer supported properties.

Parameters:

stream - stream to print to.

printConfigurable

public static void printConfigurable(java.io.PrintStream stream,
                                     IConfigurable configObj)

Print out all configurable options on the IConfigurable object.

Parameters:

stream - stream to print to

configObj - IConfigurable object.

printOption

public static void printOption(java.io.PrintStream stream,
                               IConfigurable configObj,
                               IProperty prop)

Print information about the property on the configurable object.

Parameters:

stream - stream to print to

configObj - configurable object

prop - property on object

configure

public static int configure(java.util.Properties properties,
                            IConfigurable config)

Configures an IConfigurable from a set of Java Properties.

Here's some sample code that shows configuring a IStreamCoder from a FFmpeg preset file:

   Properties props = new Properties();
   props.load(new FileInputStream(file));
   IStreamCoder coder = IStreamCoder.make(Direction.ENCODING);
   int retval = Configuration.configure(props, coder);
   if (retval < 0)
      throw new RuntimeException("Could not configure object");
 

Parameters:

properties - The properties to use.

config - The item to configure.

Returns:

<0 on error; >= 0 on success.

Since:

3.4

configure

public static int configure(java.lang.String file,
                            IConfigurable config)

Configures an IConfigurable from a file.

This is a handy way to configure a AVPKit IConfigurable object, and will also work with FFmpeg preset files.

Parameters:

file - A filename for the properties file.

config - The item to configure.

Returns:

<0 on error; >= 0 on success.

Since:

3.4