One Logo Pool Ball
Media · IOS API REFERENCE

MediaToolbox

Enable support for media format readers; tap and process audio from an audio mix.

9 types

21 callable entries

6 skipped

78% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

Functions and constants

get

kMTAudioProcessingTapCallbacksVersion_0

TypeScript
const kMTAudioProcessingTapCallbacksVersion_0: number
Swift declaration
var kMTAudioProcessingTapCallbacksVersion_0: Int32 { get }
get

kMTAudioProcessingTapCreationFlag_PostEffects

TypeScript
const kMTAudioProcessingTapCreationFlag_PostEffects: number
Swift declaration
var kMTAudioProcessingTapCreationFlag_PostEffects: MTAudioProcessingTapCreationFlags { get }
get

kMTAudioProcessingTapCreationFlag_PreEffects

TypeScript
const kMTAudioProcessingTapCreationFlag_PreEffects: number
Swift declaration
var kMTAudioProcessingTapCreationFlag_PreEffects: MTAudioProcessingTapCreationFlags { get }
get

kMTAudioProcessingTapFlag_EndOfStream

TypeScript
const kMTAudioProcessingTapFlag_EndOfStream: number
Swift declaration
var kMTAudioProcessingTapFlag_EndOfStream: MTAudioProcessingTapFlags { get }
get

kMTAudioProcessingTapFlag_StartOfStream

TypeScript
const kMTAudioProcessingTapFlag_StartOfStream: number
Swift declaration
var kMTAudioProcessingTapFlag_StartOfStream: MTAudioProcessingTapFlags { get }
function · iOS 6.0+

MTAudioProcessingTapCreate

TypeScript
MTAudioProcessingTapCreate(allocator: (_CoreFoundation_CFAllocator) | null, callbacks: SDKHandle, flags: number): { $ret: number; $out: { "tapOut": (MTAudioProcessingTap) | null } }
Swift declaration
func MTAudioProcessingTapCreate(_ allocator: CFAllocator?, _ callbacks: UnsafePointer<MTAudioProcessingTapCallbacks>, _ flags: MTAudioProcessingTapCreationFlags, _ tapOut: UnsafeMutablePointer<MTAudioProcessingTap?>) -> OSStatus

Omit the output parameters from the call. The result contains $ret and $out, with tapOut inside $out.

function · iOS 27.0+

MTAudioProcessingTapCreateWithPreferredFormat

TypeScript
MTAudioProcessingTapCreateWithPreferredFormat(allocator: (_CoreFoundation_CFAllocator) | null, callbacks: SDKHandle, flags: number, preferredFormat?: (_CoreMedia_CMFormatDescription) | null): { $ret: number; $out: { "tapOut": (MTAudioProcessingTap) | null } }
Swift declaration
func MTAudioProcessingTapCreateWithPreferredFormat(_ allocator: CFAllocator?, _ callbacks: UnsafePointer<MTAudioProcessingTapCallbacks>, _ flags: MTAudioProcessingTapCreationFlags, _ preferredFormat: CMAudioFormatDescription?, _ tapOut: UnsafeMutablePointer<MTAudioProcessingTap?>) -> OSStatus

Omit the output parameters from the call. The result contains $ret and $out, with tapOut inside $out.

function · iOS 6.0+

MTAudioProcessingTapGetSourceAudio

TypeScript
MTAudioProcessingTapGetSourceAudio(tap: MTAudioProcessingTap, numberFrames: number, bufferListInOut: SDKHandle, flagsOut?: (SDKHandle) | null, timeRangeOut?: (SDKHandle) | null, numberFramesOut?: (SDKHandle) | null): number
Swift declaration
func MTAudioProcessingTapGetSourceAudio(_ tap: MTAudioProcessingTap, _ numberFrames: CMItemCount, _ bufferListInOut: UnsafeMutablePointer<AudioBufferList>, _ flagsOut: UnsafeMutablePointer<MTAudioProcessingTapFlags>?, _ timeRangeOut: UnsafeMutablePointer<CMTimeRange>?, _ numberFramesOut: UnsafeMutablePointer<CMItemCount>?) -> OSStatus
function · iOS 6.0+

MTAudioProcessingTapGetStorage

TypeScript
MTAudioProcessingTapGetStorage(tap: MTAudioProcessingTap): SDKHandle
Swift declaration
func MTAudioProcessingTapGetStorage(_ tap: MTAudioProcessingTap) -> UnsafeMutableRawPointer
function · iOS 6.0+

MTAudioProcessingTapGetTypeID

TypeScript
MTAudioProcessingTapGetTypeID(): number
Swift declaration
func MTAudioProcessingTapGetTypeID() -> CFTypeID
function · iOS 6.0+

MTCopyLocalizedNameForMediaSubType

TypeScript
MTCopyLocalizedNameForMediaSubType(mediaType: SDKHandle, mediaSubType: SDKHandle): (_CoreFoundation_CFString) | null
Swift declaration
func MTCopyLocalizedNameForMediaSubType(_ mediaType: CMMediaType, _ mediaSubType: FourCharCode) -> CFString?
function · iOS 6.0+

MTCopyLocalizedNameForMediaType

TypeScript
MTCopyLocalizedNameForMediaType(mediaType: SDKHandle): (_CoreFoundation_CFString) | null
Swift declaration
func MTCopyLocalizedNameForMediaType(_ mediaType: CMMediaType) -> CFString?

Skipped declarations

6 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

MTAudioProcessingTapCallbacks.init(version:clientInfo:init:finalize:prepare:unprepare:process:)

This output pointer cannot safely be represented by the bridge.

MTAudioProcessingTapCallbacks.init

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure

MTAudioProcessingTapCallbacks.finalize

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure

MTAudioProcessingTapCallbacks.prepare

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure

MTAudioProcessingTapCallbacks.unprepare

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure

MTAudioProcessingTapCallbacks.process

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure