#include <AudioStreamBase.h>
Inheritance diagram for oboe::AudioStreamBase:
Protected Member Functions | |
| virtual Result | isValidConfig () |
Protected Attributes | |
| AudioStreamDataCallback * | mDataCallback = nullptr |
| std::shared_ptr< AudioStreamDataCallback > | mSharedDataCallback |
| AudioStreamErrorCallback * | mErrorCallback = nullptr |
| std::shared_ptr< AudioStreamErrorCallback > | mSharedErrorCallback |
| int32_t | mFramesPerCallback = kUnspecified |
| int32_t | mChannelCount = kUnspecified |
| int32_t | mSampleRate = kUnspecified |
| int32_t | mDeviceId = kUnspecified |
| int32_t | mBufferCapacityInFrames = kUnspecified |
| int32_t | mBufferSizeInFrames = kUnspecified |
| ChannelMask | mChannelMask = ChannelMask::Unspecified |
| SharingMode | mSharingMode = SharingMode::Shared |
| AudioFormat | mFormat = AudioFormat::Unspecified |
| Direction | mDirection = Direction::Output |
| PerformanceMode | mPerformanceMode = PerformanceMode::None |
| Usage | mUsage = Usage::Media |
| ContentType | mContentType = ContentType::Music |
| InputPreset | mInputPreset = InputPreset::VoiceRecognition |
| SessionId | mSessionId = SessionId::None |
| AllowedCapturePolicy | mAllowedCapturePolicy = AllowedCapturePolicy::Unspecified |
| PrivacySensitiveMode | mPrivacySensitiveMode = PrivacySensitiveMode::Unspecified |
| std::string | mPackageName |
| std::string | mAttributionTag |
| bool | mIsContentSpatialized = false |
| SpatializationBehavior | mSpatializationBehavior = SpatializationBehavior::Unspecified |
| int32_t | mHardwareChannelCount = kUnspecified |
| int32_t | mHardwareSampleRate = kUnspecified |
| AudioFormat | mHardwareFormat = AudioFormat::Unspecified |
| bool | mChannelConversionAllowed = false |
| bool | mFormatConversionAllowed = false |
| SampleRateConversionQuality | mSampleRateConversionQuality = SampleRateConversionQuality::Medium |
Detailed Description
Base class containing parameters for audio streams and builders.
Constructor & Destructor Documentation
◆ AudioStreamBase()
|
default |
Default copy constructor
Member Function Documentation
◆ getAllowedCapturePolicy()
|
inline |
Return the policy that determines whether the audio may or may not be captured by other apps or the system.
See AudioStreamBuilder_setAllowedCapturePolicy().
Added in API level 29 to AAudio.
- Returns
- the allowed capture policy, for example AllowedCapturePolicy::All
◆ getBufferCapacityInFrames()
- Returns
- capacityInFrames or kUnspecified
◆ getBufferSizeInFrames()
Query the maximum number of frames that can be filled without blocking. If the stream has been closed the last known value will be returned.
- Returns
- buffer size
◆ getChannelCount()
|
inline |
- Returns
- number of channels, for example 2 for stereo, or kUnspecified
◆ getChannelMask()
|
inline |
- Returns
- the stream's channel mask.
◆ getContentType()
|
inline |
- Returns
- the stream's content type.
◆ getDataCallback()
|
inline |
For internal use only.
- Returns
- the data callback object for this stream, if set.
◆ getDeviceId()
|
inline |
- Returns
- the device ID of the stream.
◆ getDirection()
|
inline |
- Returns
- Direction::Input or Direction::Output
◆ getErrorCallback()
|
inline |
For internal use only.
- Returns
- the error callback object for this stream, if set.
◆ getFormat()
|
inline |
- Returns
- the audio sample format (e.g. Float or I16)
◆ getFramesPerCallback()
|
inline |
- Deprecated:
- use
getFramesPerDataCallbackinstead.
◆ getFramesPerDataCallback()
|
inline |
- Returns
- the number of frames in each data callback or kUnspecified.
◆ getHardwareChannelCount()
|
inline |
- Returns
- number of channels for the hardware, for example 2 for stereo, or kUnspecified.
◆ getHardwareFormat()
|
inline |
- Returns
- the audio sample format of the hardware (e.g. Float or I16)
◆ getHardwareSampleRate()
|
inline |
- Returns
- hardware sample rate for the stream or kUnspecified
◆ getInputPreset()
|
inline |
- Returns
- the stream's input preset.
◆ getPerformanceMode()
|
inline |
- Returns
- the performance mode of the stream.
◆ getPrivacySensitiveMode()
|
inline |
Return whether this input stream is marked as privacy sensitive.
See AudioStreamBuilder_setPrivacySensitiveMode().
Added in API level 30 to AAudio.
- Returns
- PrivacySensitiveMode::Enabled if privacy sensitive, PrivacySensitiveMode::Disabled if not privacy sensitive, and PrivacySensitiveMode::Unspecified if API is not supported.
◆ getSampleRate()
|
inline |
- Returns
- sample rate for the stream or kUnspecified
◆ getSampleRateConversionQuality()
|
inline |
- Returns
- whether and how Oboe can convert sample rates to achieve optimal results.
◆ getSessionId()
|
inline |
- Returns
- the stream's session ID allocation strategy (None or Allocate).
◆ getSharingMode()
|
inline |
- Returns
- the sharing mode of the stream.
◆ getSpatializationBehavior()
|
inline |
- Returns
- the spatialization behavior for the stream.
◆ getUsage()
|
inline |
- Returns
- the usage for this stream.
◆ isChannelConversionAllowed()
|
inline |
- Returns
- true if Oboe can convert channel counts to achieve optimal results.
◆ isContentSpatialized()
|
inline |
- Returns
- whether the content of the stream is spatialized.
◆ isDataCallbackSpecified()
|
inline |
- Returns
- true if a data callback was set for this stream
◆ isErrorCallbackSpecified()
|
inline |
Note that if the app does not set an error callback then a default one may be provided.
- Returns
- true if an error callback was set for this stream
◆ isFormatConversionAllowed()
|
inline |
- Returns
- true if Oboe can convert data formats to achieve optimal results.
◆ isValidConfig()
|
inlineprotectedvirtual |
Validate stream parameters that might not be checked in lower layers
◆ operator=()
|
default |
Default assignment operator
Member Data Documentation
◆ mAllowedCapturePolicy
|
protected |
Allowed Capture Policy. Only active on Android 29+
◆ mAttributionTag
|
protected |
Control the attribution tag of the context creating the stream. Only active on Android 31+
◆ mBufferCapacityInFrames
|
protected |
Stream buffer capacity specified as a number of audio frames
◆ mBufferSizeInFrames
|
protected |
Stream buffer size specified as a number of audio frames
◆ mChannelCount
|
protected |
Stream channel count
◆ mChannelMask
|
protected |
Stream channel mask. Only active on Android 32+
◆ mContentType
|
protected |
Stream content type. Only active on Android 28+
◆ mDataCallback
|
protected |
The callback which will be fired when new data is ready to be read/written.
◆ mDeviceId
|
protected |
Stream audio device ID
◆ mDirection
|
protected |
Stream direction
◆ mErrorCallback
|
protected |
The callback which will be fired when an error or a disconnect occurs.
◆ mFormat
|
protected |
Format of audio frames
◆ mFramesPerCallback
|
protected |
Number of audio frames which will be requested in each callback
◆ mHardwareChannelCount
|
protected |
Hardware channel count. Only specified on Android 34+ AAudio streams
◆ mHardwareFormat
|
protected |
Hardware format. Only specified on Android 34+ AAudio streams
◆ mHardwareSampleRate
|
protected |
Hardware sample rate. Only specified on Android 34+ AAudio streams
◆ mInputPreset
|
protected |
Stream input preset. Only active on Android 28+ TODO InputPreset::Unspecified should be considered as a possible default alternative.
◆ mIsContentSpatialized
Whether the content is already spatialized. Only used on Android 32+
◆ mPackageName
|
protected |
Control the name of the package creating the stream. Only active on Android 31+
◆ mPerformanceMode
|
protected |
Stream performance mode
◆ mPrivacySensitiveMode
|
protected |
Privacy Sensitive Mode. Only active on Android 30+
◆ mSampleRate
|
protected |
Stream sample rate
◆ mSessionId
|
protected |
Stream session ID allocation strategy. Only active on Android 28+
◆ mSharingMode
|
protected |
Stream sharing mode
◆ mSpatializationBehavior
|
protected |
Spatialization Behavior. Only active on Android 32+
◆ mUsage
|
protected |
Stream usage. Only active on Android 28+
The documentation for this class was generated from the following file:
- include/oboe/AudioStreamBase.h
