C++ API Library Reference  4.3.2-74-ge1d4cca
Public Functions | List of all members
EncoderFormatParameterMap Class Reference

The EncoderFormatParameterMap class allows you to create your own custom encoder format object from the ground up by creating an array of the parameters that you care about.

Public Functions

void Add (String const &key, String const &value)
 
void Add (KeyValuePair< String, String > const &item)
 
void Clear ()
 
bool Contains (KeyValuePair< String, String > item)
 
bool ContainsKey (String const &key)
 
void CopyTo (Array< KeyValuePair< String, String > > array, int arrayIndex)
 
int Count ()
 
const CSI::Collections::IEnumerator< KeyValuePair< String, String > > & GetEnumerator ()
 
bool IsReadOnly ()
 
const CSI::Collections::ICollection< String > & Keys ()
 
void OnChanged (EmptyEventArgs e)
 
Stringoperator[] (const String key)
 
bool Remove (String const &key)
 
bool Remove (KeyValuePair< String, String > item)
 
bool TryGetValue (String const &key, String &value)
 
const CSI::Collections::ICollection< String > & Values ()
 

Usage Description

void Add ( String const &  key,
String const &  value 
)
inline

Adds the specified parameter to the parameter map.

void Add ( KeyValuePair< String, String > const &  item)
inline

Adds the specified parameter to the parameter map.

void Clear ( )
inline

Clears the parameter map by removing any previously set parameter.

bool Contains ( KeyValuePair< String, String item)
inline

Checks whether the parameter map contains the specified parameter. Returns true if it does, or false otherwise.

bool ContainsKey ( String const &  key)
inline

Checks whether the parameter map contains the specified key. Returns true if it does, and false otherwise.

void CopyTo ( Array< KeyValuePair< String, String > >  array,
int  arrayIndex 
)
inline

Copies content to the specified position in the parameter map.

int Count ( )
inline

Returns the number of parameters currently set in the parameter map.

const CSI::Collections::IEnumerator<KeyValuePair<String, String> >& GetEnumerator ( )
inline

Returns the array enumerator for the parameter map.

bool IsReadOnly ( )
inline

Checks whether the parameter map is read-only. Returns true if it is, or false otherwise.

const CSI::Collections::ICollection<String>& Keys ( )
inline

Returns the list of all the keys currently set in the parameter map.

void OnChanged ( EmptyEventArgs  e)
inline

The event handler that gets fired whenever the client updates the encoder configuration.

String& operator[] ( const String  key)
inline

Returns a reference to the element associated with the given key in the array container.

bool Remove ( String const &  key)
inline

Removes the specified key from the parameter map.

bool Remove ( KeyValuePair< String, String item)
inline

Removes the specified parameters from the parameter map.

bool TryGetValue ( String const &  key,
String value 
)
inline

Checks whether the parameter map contains the specified key-value pair. If it does, returns true and assigns the value to the parameter. Otherwise, returns false.

const CSI::Collections::ICollection<String>& Values ( )
inline

Returns the list of all the values currently set in the parameter map.