MiXiD API Reference: Capture

Documentation Menu

• About XCFrameworks
• How to Consume
• Swift and Objective-C Examples
• Platform Slices
• API Reference
• Getting Started
• Capture
• Compositing and Mixing
• RTMP
• SRT
• HLS
• RTSP and ONVIF
• Media Files and Replay
• NDI
• WebRTC and WHIP

Reference size:
52 headers
260 properties
354 methods and callbacks

Back to MiXiD API Documentation

Detailed MiXiD XCFramework reference for Capture. Read through each header, class, protocol, and function section to inspect Objective-C declarations, parameters, return values, and usage guidance.

Capture

Capture

MXDCameraSource.h

Camera and microphone capture source.

MXDCameraSourceDeviceDescriptor

Name	Declaration	Details
uniqueID	@property (nonatomic, copy, readonly) NSString *uniqueID;	Public configuration or state exposed by this API.
displayName	@property (nonatomic, copy, readonly) NSString *displayName;	Public configuration or state exposed by this API.

initWithUniqueID:displayName:

- (instancetype)initWithUniqueID:(NSString *)uniqueID displayName:(NSString *)displayName;

Kind	Instance method
Return	instancetype
Details	Initializes the receiver for initWithUniqueID displayName. Use this to provide required URLs, ports, names, peer connections, or configuration objects.
Parameters	initWithUniqueID (NSString *, uniqueID); displayName (NSString *, displayName)
Swift usage	let value = MXDCameraSourceDeviceDescriptor(initWithUniqueID: "value", displayName: "value")

MXDCameraSourceDelegate Protocol

cameraSourceDidOutputVideoFrame:presentationTime:

- (void)cameraSourceDidOutputVideoFrame:(CVImageBufferRef)imageBuffer presentationTime:(CMTime)presentationTime;

Kind	Delegate / protocol callback
Return	void
Details	Callback invoked by MiXiD for cameraSourceDidOutputVideoFrame presentationTime. Implement this method to observe lifecycle, media output, status, or error events.
Parameters	cameraSourceDidOutputVideoFrame (CVImageBufferRef, imageBuffer); presentationTime (CMTime, presentationTime)
Swift usage	instance.cameraSourceDidOutputVideoFrame(cameraSourceDidOutputVideoFrame: imageBuffer, presentationTime: 0.0)

cameraSourceDidOutputAudioBuffer:

- (void)cameraSourceDidOutputAudioBuffer:(AVAudioPCMBuffer *)audioBuffer;

Kind	Delegate / protocol callback
Return	void
Details	Callback invoked by MiXiD for cameraSourceDidOutputAudioBuffer. Implement this method to observe lifecycle, media output, status, or error events.
Parameters	cameraSourceDidOutputAudioBuffer (AVAudioPCMBuffer *, audioBuffer)
Swift usage	instance.cameraSourceDidOutputAudioBuffer(cameraSourceDidOutputAudioBuffer: audioBuffer)

cameraSourceDidFailWithError:

- (void)cameraSourceDidFailWithError:(NSError *)error;

Kind	Delegate / protocol callback
Return	void
Details	Callback invoked by MiXiD for cameraSourceDidFailWithError. Implement this method to observe lifecycle, media output, status, or error events.
Parameters	cameraSourceDidFailWithError (NSError *, error)
Swift usage	instance.cameraSourceDidFailWithError(cameraSourceDidFailWithError: nil)

MXDCameraSource

Name	Declaration	Details
delegate	@property (nonatomic, weak, nullable) id<MXDCameraSourceDelegate> delegate;	Receives lifecycle, media output, status, or error callbacks.
running	@property (nonatomic, assign, readonly, getter=isRunning) BOOL running;	Read-only runtime state flag.
preferredVideoDeviceUniqueID	@property (nonatomic, copy, nullable) NSString *preferredVideoDeviceUniqueID;	Public configuration or state exposed by this API.

availableVideoDeviceDescriptors

+ (NSArray<MXDCameraSourceDeviceDescriptor *> *)availableVideoDeviceDescriptors;

Kind	Class method
Return	NSArray<MXDCameraSourceDeviceDescriptor *> *
Details	Creates, discovers, or returns shared information for availableVideoDeviceDescriptors. Call this on the class before creating or configuring an instance.
Parameters	No parameters.
Swift usage	let result = MXDCameraSource.availableVideoDeviceDescriptors()

availableVideoDeviceDescriptors

- (NSArray<MXDCameraSourceDeviceDescriptor *> *)availableVideoDeviceDescriptors;

Kind	Instance method
Return	NSArray<MXDCameraSourceDeviceDescriptor *> *
Details	Returns derived state, buffered data, preview information, or available source metadata from the component.
Parameters	No parameters.
Swift usage	let result = instance.availableVideoDeviceDescriptors()

selectedVideoDeviceDescriptor

- (nullable MXDCameraSourceDeviceDescriptor *)selectedVideoDeviceDescriptor;

Kind	Instance method
Return	nullable MXDCameraSourceDeviceDescriptor *
Details	Returns derived state, buffered data, preview information, or available source metadata from the component.
Parameters	No parameters.
Swift usage	let result = instance.selectedVideoDeviceDescriptor()

start

- (void)start;

Kind	Instance method
Return	void
Details	Starts the component and begins the related capture, server, playback, publish, recording, or discovery workflow.
Parameters	No parameters.
Swift usage	instance.start()

stop

- (void)stop;

Kind	Instance method
Return	void
Details	Stops the component and releases or finalizes active workflow resources.
Parameters	No parameters.
Swift usage	instance.stop()

---

Back to API Reference index