ILMSsfWrtAudioStream Interface

Properties

Type Name Description
long BitrateSupportedCount (Read-only) Gets the current count of supported bitrates.
long Bitrate Gets or sets the desired bitrate for the audio stream. This value is in kilobits/second.
long ChannelsSupportedCount (Read-only) Gets the current count of audio channels supported.
long Channels Gets or sets the channels type (Stereo, 5.1, 7.1).
long SampleRateSupportedCount (Read-only) Gets the current count of audio sample rate supported.
long SampleRate Gets or sets the desired sample rate.
long BitsPerSampleSupportedCount (Read-only) Gets the current count of bits / sample supported.
long BitsPerSample Gets or sets the bits per sample.

Methods

HRESULT GetBitrateSupported(long index, long* pVal);

Description

Gets the supported bitrate value at the specified index. The value returned is measured in kilobits/second. For example, a value of 192 means 192 kbps.

Parameters

index

Index of desired bitrate value.

pVal

Pointer to the long value representing the returned bitrate.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.

HRESULT IsBitrateSupported(long bitrate, VARIANT_BOOL* pVal);

Description

Checks the specified bitrate for support.

Parameters

bitrate

A long value representing the bitrate to check. The bitrate should be in kilobits/second.

pVal

Pointer to the VARIANT_BOOL value indicating whether or not the bitrate is supported.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
E_POINTER [0x80004003] pVal is NULL.

HRESULT GetChannelsSupported(long index, long* pVal);

Description

Gets the long value representing the audio channels type supported for the specified index, given the current audio stream bitrate.

Parameters

index

Index to the channel type.

pVal

Pointer to the long variable to receive the channel type value supported at the given index.

Comments

Possible values are: 1=Mono, 2=Stereo, 6=5.1 Surround, 8=7.1 Surround.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
E_POINTER [0x80004003] pVal is NULL.
E_INVALIDARG [0x80070057] Index is invalid.

HRESULT IsChannelsSupported(long channels, VARIANT_BOOL* pVal);

Description

Gets a boolean value indicating whether or not the current audio stream and bit rate support the desired channel type.

Parameters

channels

A long value indicating the desired channel type value. 1=Mono, 2=Stereo, 6=5.1 Surround, 8=7.1 Surround.

pVal

Pointer to the VARIANT_BOOL value indicating whether or not the channels is supported.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.

HRESULT GetSampleRateSupported(long index, long* pVal);

Description

Gets the long value representing the sample rate for the specified index, given the current audio stream bitrate.

Parameters

index

Index to the sample rate.

pVal

Pointer to the long variable to receive the sample rate value supported at the given index.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
E_POINTER [0x80004003] pVal is NULL.
E_INVALIDARG [0x80070057] Index is invalid.

HRESULT IsSampleRateSupported(long sampleRate, VARIANT_BOOL* pVal);

Description

Gets a boolean value indicating whether or not the current audio stream and bit rate support the sample rate.

Parameters

sampleRate

A long value indicating the sample rate to check.

pVal

Pointer to the VARIANT_BOOL value indicating whether or not the sample rate is supported.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.

HRESULT GetBitsPerSampleSupported(long index, long* pVal);

Parameters

index

Index to the bits per sample.

pVal

Pointer to the long variable to receive the bits per sample value supported at the given index.

Description

Gets the long value representing the bits per sample for the sample rates associated with the current channel type for the specified index, given the current audio stream bitrate.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
E_POINTER [0x80004003] pVal is NULL.
E_INVALIDARG [0x80070057] Index is invalid.

HRESULT IsBitsPerSampleSupported(long bitsPerSample, VARIANT_BOOL* pVal);

Description

Gets a boolean value indicating whether or not the current audio stream and bit rate support the bits per sample.

Parameters

sampleRate

A long value indicating the bits per sample to check.

pVal

Pointer to the VARIANT_BOOL value indicating whether or not the bits per sample is supported.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
Help Version 22.0.2022.8.23
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Filters C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.