io.humble.video

Class KeyValueBag

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.KeyValueBag

public class KeyValueBag
extends RefCounted

KeyValueBag is a bag of key/value pairs that can be embedded
in some Container or some Stream
in an Container, and are then written to
or read from a media file. Keys must be unique, and
any attempt to set a key value replaces any previous values.

An example is the "title" meta-data item in an MP3 file.

Support for KeyValueBag differs depending upon the
Container format you're using and the implementation
in FFmpeg. For example,
MP3 meta-data reading and writing is supported, but
(as of the writing of this comment) FLV meta-data writing
is not supported.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyValueBag.Flags Different types of flags that can be passed to KeyValueBag#getValue

Method Summary

Modifier and Type	Method and Description
KeyValueBag	copyReference() Create a new KeyValueBag object that is actually referring to the exact same underlying native object.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
Collection<String>	getKeys() Get the set of keys currently in this KeyValueBag object as an unordered collection.
int	getNumKeys() Get the total number of keys currently in this KeyValueBag object.
String	getValue(String key) Return the value for this key, comparing case insensitively.
String	getValue(String key, KeyValueBag.Flags flag) Get the value for the given key.
int	hashCode() Get a hashable value for this object.
static KeyValueBag	make() Create a new KeyValueBag bag of properties with no values set.
int	setValue(String key, String value) Sets the value for the given key to value.
int	setValue(String key, String value, KeyValueBag.Flags flag) Sets the value for the given key to value.
String	toString() Return the meta-data, with all values expanded.

Methods inherited from class io.humble.ferry.RefCounted

delete, getCurrentRefCount

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

copyReference

public KeyValueBag copyReference()

Create a new KeyValueBag object that is actually referring to the exact same underlying native object.

Overrides:

copyReference in class RefCounted

Returns:

the new Java object.

equals

public boolean equals(Object obj)

Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.

Overrides:

equals in class Object

Returns:

True if the underlying native object is the same. False otherwise.

hashCode

public int hashCode()

Get a hashable value for this object.

Overrides:

hashCode in class Object

Returns:

the hashable value.

toString

public String toString()

Return the meta-data, with all values expanded.

Overrides:

toString in class Object

getKeys

public Collection<String> getKeys()

Get the set of keys currently in this KeyValueBag object as an unordered collection.

Returns:

the keys.

getValue

public String getValue(String key)

Return the value for this key, comparing case insensitively.

Parameters:

key - the key

Returns:

the value.

getNumKeys

public int getNumKeys()

Get the total number of keys currently in this
KeyValueBag object.

Returns:

the number of keys.

getValue

public String getValue(String key,
                       KeyValueBag.Flags flag)

Get the value for the given key.

Parameters:

key - The key

flag - A flag for how to search

Returns:

The value, or null if none.

setValue

public int setValue(String key,
                    String value)

Sets the value for the given key to value. This overrides
any prior setting for key, or adds key to the meta-data
if appropriate.

Parameters:

key - The key to set.

value - The value to set.

make

public static KeyValueBag make()

Create a new KeyValueBag bag of properties with
no values set.

setValue

public int setValue(String key,
                    String value,
                    KeyValueBag.Flags flag)

Sets the value for the given key to value. This overrides
any prior setting for key, or adds key to the meta-data
if appropriate.

Parameters:

key - The key to set.

value - The value to set.

flag - A flag on how this should be set.

Since:

5.0