PropertyCollection class

Package:

microsoft-cognitiveservices-speech-sdk

Represents collection of properties and their values.

Properties

keys	Get the keys in Property Collection.

Methods

clone()	Clones the collection.
getProperty(string | PropertyId, string | number | boolean)	Returns the property value in type String. Currently only String, int and bool are allowed. If the name is not available, the specified defaultValue is returned.
mergeTo(PropertyCollection)	Merges this set of properties into another, no overwrites.
setProperty(string | PropertyId, string)	Sets the String value of the parameter specified by name.

Property Details

keys

Get the keys in Property Collection.

string[] keys

Property Value

string[]

Keys in the collection.

Method Details

clone()

Clones the collection.

function clone(): PropertyCollection

Returns

PropertyCollection

A copy of the collection.

getProperty(string | PropertyId, string | number | boolean)

Returns the property value in type String. Currently only String, int and bool are allowed. If the name is not available, the specified defaultValue is returned.

function getProperty(key: string | PropertyId, def?: string | number | boolean): string

Parameters

key

string | PropertyId

The parameter name.

def

string | number | boolean

The default value which is returned if the parameter is not available in the collection.

Returns

string

value of the parameter.

mergeTo(PropertyCollection)

Merges this set of properties into another, no overwrites.

function mergeTo(destinationCollection: PropertyCollection)

Parameters

destinationCollection

PropertyCollection

The collection to merge into.

setProperty(string | PropertyId, string)

Sets the String value of the parameter specified by name.

function setProperty(key: string | PropertyId, value: string)

Parameters

key

string | PropertyId

The parameter name.

value

string

The value of the parameter.