coreaudiotypes

Documentation

Overview

Use specialized data types to interact with audio streams, complex buffers, and audiovisual timestamps.

Apple Documentation

Index

• type AudioInteger
• type AudioSessionErrorCode
• type AudioUInteger
• type Buffer
• type BufferList
• type ChannelBitmap
• type ChannelCoordinateIndex
• type ChannelDescription
• type ChannelFlags
• type ChannelLabel
• type ChannelLayout
• type ChannelLayoutTag
• type ClassDescription
• type EG4ObjectID
• type FormatFlags
• type FormatID
• type FormatListItem
• type SMPTETime
• type SMPTETimeFlags
• type SMPTETimeType
• type SampleType
• type SessionID
• type StreamBasicDescription
• type StreamPacketDescription
• type TimeStamp
• type TimeStampFlags
• type UnitSampleType
• type ValueRange
• type ValueTranslation

Types

type AudioInteger

type AudioInteger int32

An integer type for audio operations. Full Topic

type AudioSessionErrorCode

type AudioSessionErrorCode AudioInteger

Codes that describe error conditions that may occur when performing audio session operations. Full Topic

const (
	AudioSessionErrorCodeBadParam              AudioSessionErrorCode = -50
	AudioSessionErrorCodeCannotInterruptOthers AudioSessionErrorCode = 560557684
	AudioSessionErrorCodeCannotStartPlaying    AudioSessionErrorCode = 561015905
	AudioSessionErrorCodeCannotStartRecording  AudioSessionErrorCode = 561145187
	AudioSessionErrorCodeExpiredSession        AudioSessionErrorCode = 561210739
	AudioSessionErrorCodeIncompatibleCategory  AudioSessionErrorCode = 560161140
	AudioSessionErrorCodeIsBusy                AudioSessionErrorCode = 560030580
	AudioSessionErrorCodeMediaServicesFailed   AudioSessionErrorCode = 1836282486
	AudioSessionErrorCodeMissingEntitlement    AudioSessionErrorCode = 1701737535
	AudioSessionErrorCodeNone                  AudioSessionErrorCode = 0
	AudioSessionErrorCodeResourceNotAvailable  AudioSessionErrorCode = 561145203
	AudioSessionErrorCodeSessionNotActive      AudioSessionErrorCode = 1768841571
	AudioSessionErrorCodeSiriIsRecording       AudioSessionErrorCode = 1936290409
	AudioSessionErrorCodeUnspecified           AudioSessionErrorCode = 2003329396
)

type AudioUInteger

type AudioUInteger int32

An unsigned integer type for audio operations. Full Topic

type Buffer

type Buffer struct {
	MNumberChannels uint32
	MDataByteSize   uint32
	MData           uintptr
}

A structure that holds a buffer of audio data. Full Topic

type BufferList

type BufferList struct {
	MNumberBuffers uint32
	MBuffers       [1]Buffer
}

A structure that stores a variable-length array of audio buffers. Full Topic

type ChannelBitmap

type ChannelBitmap uint32

The supported channel bitmaps to use when defining channel layouts. Full Topic

const (
	KChannelBit_Center               ChannelBitmap = 4
	KChannelBit_CenterSurround       ChannelBitmap = 256
	KChannelBit_CenterTopFront       ChannelBitmap = 8192
	KChannelBit_CenterTopMiddle      ChannelBitmap = 2048
	KChannelBit_CenterTopRear        ChannelBitmap = 33554432
	KChannelBit_LFEScreen            ChannelBitmap = 8
	KChannelBit_Left                 ChannelBitmap = 1
	KChannelBit_LeftCenter           ChannelBitmap = 64
	KChannelBit_LeftSurround         ChannelBitmap = 16
	KChannelBit_LeftSurroundDirect   ChannelBitmap = 512
	KChannelBit_LeftTopFront         ChannelBitmap = 4096
	KChannelBit_LeftTopMiddle        ChannelBitmap = 2097152
	KChannelBit_LeftTopRear          ChannelBitmap = 16777216
	KChannelBit_Right                ChannelBitmap = 2
	KChannelBit_RightCenter          ChannelBitmap = 128
	KChannelBit_RightSurround        ChannelBitmap = 32
	KChannelBit_RightSurroundDirect  ChannelBitmap = 1024
	KChannelBit_RightTopFront        ChannelBitmap = 16384
	KChannelBit_RightTopMiddle       ChannelBitmap = 8388608
	KChannelBit_RightTopRear         ChannelBitmap = 67108864
	KChannelBit_TopBackCenter        ChannelBitmap = 65536
	KChannelBit_TopBackLeft          ChannelBitmap = 32768
	KChannelBit_TopBackRight         ChannelBitmap = 131072
	KChannelBit_TopCenterSurround    ChannelBitmap = 2048
	KChannelBit_VerticalHeightCenter ChannelBitmap = 8192
	KChannelBit_VerticalHeightLeft   ChannelBitmap = 4096
	KChannelBit_VerticalHeightRight  ChannelBitmap = 16384
)

type ChannelCoordinateIndex

type ChannelCoordinateIndex uint32

Indexes the fields of the mCoordinates array in an AudioChannelDescription structure. Full Topic

const (
	KChannelCoordinates_Azimuth   ChannelCoordinateIndex = 0
	KChannelCoordinates_BackFront ChannelCoordinateIndex = 1
	KChannelCoordinates_Distance  ChannelCoordinateIndex = 2
	KChannelCoordinates_DownUp    ChannelCoordinateIndex = 2
	KChannelCoordinates_Elevation ChannelCoordinateIndex = 1
	KChannelCoordinates_LeftRight ChannelCoordinateIndex = 0
)

type ChannelDescription

type ChannelDescription struct {
	MChannelLabel uint32
	MChannelFlags uint32
	MCoordinates  [3]float32
}

A structure that describes a channel of audio data. Full Topic

type ChannelFlags

type ChannelFlags uint32

Constants that define the audio channel flags of an audio channel description. Full Topic

const (
	KChannelFlags_AllOff                 ChannelFlags = 0
	KChannelFlags_Meters                 ChannelFlags = 4
	KChannelFlags_RectangularCoordinates ChannelFlags = 1
	KChannelFlags_SphericalCoordinates   ChannelFlags = 2
)

type ChannelLabel

type ChannelLabel uint32

Identifies how an audio data channel is to be used. Full Topic

type ChannelLayout

type ChannelLayout struct {
	MChannelLayoutTag          uint32
	MChannelBitmap             uint32
	MNumberChannelDescriptions uint32
	MChannelDescriptions       [1]ChannelDescription
}

A structure that specifies a channel layout in a file or in hardware. Full Topic

type ChannelLayoutTag

type ChannelLayoutTag uint32

Identifies a previously-defined channel layout. Full Topic

type ClassDescription

type ClassDescription struct {
	MType         uint32
	MSubType      uint32
	MManufacturer uint32
}

A structure that describes an audio codec. Full Topic

type EG4ObjectID

type EG4ObjectID int32

Constants that define the type of MPEG-4 audio data. Full Topic

type FormatFlags

type FormatFlags uint32

A type definition for audio format flags. Full Topic

type FormatID

type FormatID uint32

A type definition for audio format identifiers. Full Topic

type FormatListItem

type FormatListItem struct {
	MASBD             StreamBasicDescription
	MChannelLayoutTag uint32
	Pad_cgo_0         [4]byte
}

Represents a value from the audiotoolbox/audio_format_property_identifier/kaudioformatproperty_formatlist property. Full Topic

type SMPTETime

type SMPTETime struct {
	MSubframes       int16
	MSubframeDivisor int16
	MCounter         uint32
	MType            uint32
	MFlags           uint32
	MHours           int16
	MMinutes         int16
	MSeconds         int16
	MFrames          int16
}

A structure that defines an SMPTE time value. Full Topic

type SMPTETimeFlags

type SMPTETimeFlags uint32

A structure that defines SMPTE time flags. Full Topic

type SMPTETimeType

type SMPTETimeType uint32

Constants that define SMPTE time types. Full Topic

type SampleType

type SampleType float32

The canonical audio data sample type for input and output. Full Topic

type SessionID

type SessionID uint32

A unique identifier of an audio session. Full Topic

type StreamBasicDescription

type StreamBasicDescription struct {
	MSampleRate       float64
	MFormatID         uint32
	MFormatFlags      uint32
	MBytesPerPacket   uint32
	MFramesPerPacket  uint32
	MBytesPerFrame    uint32
	MChannelsPerFrame uint32
	MBitsPerChannel   uint32
	MReserved         uint32
}

A format specification for an audio stream. Full Topic

type StreamPacketDescription

type StreamPacketDescription struct {
	MStartOffset            int64
	MVariableFramesInPacket uint32
	MDataByteSize           uint32
}

A value that describes a packet in a buffer of audio data. Full Topic

type TimeStamp

type TimeStamp struct {
	MSampleTime    float64
	MHostTime      uint64
	MRateScalar    float64
	MWordClockTime uint64
	MSMPTETime     SMPTETime
	MFlags         uint32
	MReserved      uint32
}

A structure that represents a timestamp value. Full Topic

type TimeStampFlags

type TimeStampFlags uint32

A structure that represents flags for a timestamp. Full Topic

const (
	KTimeStampHostTimeValid       TimeStampFlags = 2
	KTimeStampNothingValid        TimeStampFlags = 0
	KTimeStampRateScalarValid     TimeStampFlags = 4
	KTimeStampSMPTETimeValid      TimeStampFlags = 16
	KTimeStampSampleHostTimeValid TimeStampFlags = 3
	KTimeStampSampleTimeValid     TimeStampFlags = 1
	KTimeStampWordClockTimeValid  TimeStampFlags = 8
)

type UnitSampleType

type UnitSampleType float32

The canonical audio data sample type for audio processing. Full Topic

type ValueRange

type ValueRange struct {
	MMinimum float64
	MMaximum float64
}

A structure that represents a continuous range of values. Full Topic

type ValueTranslation

type ValueTranslation struct {
	MInputData      uintptr
	MInputDataSize  uint32
	MOutputData     uintptr
	MOutputDataSize uint32
	Pad_cgo_0       [4]byte
}

A structure that stores buffers to use in translation operations. Full Topic