JPEG Image Live Streaming

Start the device's JPEG live-stream mode and render each complete JPEG image delivered by the SDK. Compatible level-2 streams can also deliver Opus audio and optional decoded PCM data.

Prerequisites

• The device is connected and ready and conforms to LiveStreamingAPI.
• supportsJPEGImageLiveStreaming is true.
• Your app can process image and optional audio callbacks without blocking the stream.

API Reference

Framework

AIBuds.xcframework

Import

Swift

Swift

import AIBuds
import UIKit

Objective-C

Objective-C

#import <AIBuds/AIBuds-Swift.h>
#import <AIBuds/AIBuds.h>
#import <UIKit/UIKit.h>

Properties

Swift

Swift

/// Whether JPEG image live streaming is supported
var supportsJPEGImageLiveStreaming: Bool { get }

Objective-C

Objective-C

/// Whether JPEG image live streaming is supported.
@property(nonatomic, readonly) BOOL supportsJPEGImageLiveStreaming;

Instance Method

Swift

Swift

/// Start JPEG image live streaming
/// - Parameters:
///   - sessionStartCompletionHandler: Session start completion handler
///   - jpegDataReceivedHandler: JPEG data received handler
///   - opusDataReceivedHandler: Opus audio data received handler (only called for level-2 Ogg/MJPEG+Opus streams)
///   - sessionFinishHandler: Session finish handler
func startJPEGImageLiveStreaming(
    withSessionStartCompletionHandler sessionStartCompletionHandler: AIBudsLiveStreamingSessionStartCompletionHandler?,
    jpegDataReceivedHandler: AIBudsLiveStreamingJpegDataReceivedHandler?,
    opusDataReceivedHandler: AIBudsLiveStreamingOpusAudioDataReceivedHandler?,
    sessionFinishHandler: AIBudsLiveStreamingSessionFinishHandler?
)

Objective-C

Objective-C

/// Start JPEG image live streaming
/// - Parameters:
///   - sessionStartCompletionHandler: Session start completion handler
///   - jpegDataReceivedHandler: JPEG data received handler
///   - opusDataReceivedHandler: Opus audio data received handler (only called for level-2 Ogg/MJPEG+Opus streams)
///   - sessionFinishHandler: Session finish handler
- (void) startJPEGImageLiveStreamingWithSessionStartCompletionHandler:(AIBudsLiveStreamingSessionStartCompletionHandler _Nullable)sessionStartCompletionHandler
                                              jpegDataReceivedHandler:(AIBudsLiveStreamingJpegDataReceivedHandler _Nullable)jpegDataReceivedHandler
                                              opusDataReceivedHandler:(AIBudsLiveStreamingOpusAudioDataReceivedHandler _Nullable)opusDataReceivedHandler
                                                 sessionFinishHandler:(AIBudsLiveStreamingSessionFinishHandler _Nullable)sessionFinishHandler;

See startJPEGImageLiveStreaming.

Callback Values

Handler	Values	Meaning
sessionStartCompletionHandler	success, error	Reports whether the live-stream session started.
jpegDataReceivedHandler	jpegData	Delivers one complete JPEG image as Data / NSData.
opusDataReceivedHandler	opusData, decodedPcmAudioData	Delivers raw Opus and optional decoded PCM audio on compatible level-2 streams.
sessionFinishHandler	isUserInitiatedStop, error	Reports the terminal session outcome and whether the stop was user initiated.

Return Value

The method does not return a value directly. Media and lifecycle results are delivered through the handlers.

Usage Examples

Swift

Swift

guard let streamingDevice = device as? LiveStreamingAPI,
    streamingDevice.supportsJPEGImageLiveStreaming
else { return }

streamingDevice.startJPEGImageLiveStreaming(
    withSessionStartCompletionHandler: { success, error in
        DispatchQueue.main.async {
            self.setStreamingActive(success)
            if let error { self.show(error) }
        }
    },
    jpegDataReceivedHandler: { jpegData in
        // Decode away from the UI update, then assign the image on the main queue.
        guard let image = UIImage(data: jpegData) else { return }
        DispatchQueue.main.async {
            self.imageView.image = image
        }
    },
    opusDataReceivedHandler: { opusData, decodedPcmAudioData in
        guard let decodedPcmAudioData, !decodedPcmAudioData.isEmpty else { return }
        self.consumePCM(decodedPcmAudioData)
    },
    sessionFinishHandler: { userStopped, error in
        DispatchQueue.main.async {
            self.setStreamingActive(false)
            self.handleFinish(userStopped: userStopped, error: error)
        }
    }
)

Objective-C

Objective-C

id<AIBudsLiveStreamingAPI> streamingDevice = (id<AIBudsLiveStreamingAPI>)self.device;
if (![streamingDevice conformsToProtocol:@protocol(AIBudsLiveStreamingAPI)] ||
    !streamingDevice.supportsJPEGImageLiveStreaming) {
    return;
}

__weak typeof(self) weakSelf = self;
[streamingDevice
    startJPEGImageLiveStreamingWithSessionStartCompletionHandler:^(BOOL success, NSError *error) {
        dispatch_async(dispatch_get_main_queue(), ^{
            [weakSelf setStreamingActive:success];
            if (error)
                [weakSelf showError:error];
        });
    }
    jpegDataReceivedHandler:^(NSData *jpegData) {
        UIImage *image = [UIImage imageWithData:jpegData];
        if (!image)
            return;
        dispatch_async(dispatch_get_main_queue(), ^{
            weakSelf.imageView.image = image;
        });
    }
    opusDataReceivedHandler:^(NSData *opusData, NSData *decodedPcmAudioData) {
        if (decodedPcmAudioData.length > 0)
            [weakSelf consumePCM:decodedPcmAudioData];
    }
    sessionFinishHandler:^(BOOL userStopped, NSError *error) {
        dispatch_async(dispatch_get_main_queue(), ^{
            [weakSelf setStreamingActive:NO];
            [weakSelf handleFinishUserStopped:userStopped error:error];
        });
    }];

Error Handling

• Reject invalid JPEG data without replacing the last valid image.
• Treat audio as optional. The audio handler is called only for compatible streams, and decoded PCM can be nil.
• Treat sessionStartCompletionHandler failure as a failed session start.
• In sessionFinishHandler, distinguish a user stop from an interruption and use error when present.
• Do not infer frame loss, frame rate, or ordering guarantees beyond the callback sequence provided by the SDK.

Best Practices

1. Avoid retaining every JPEG frame; replace the displayed image or use a bounded buffer.
2. Keep image decoding and UI assignment lightweight to avoid callback backlog.
3. Clear frame counters and presentation state when a new session begins.
4. Call stopLiveStreaming() when leaving the feature instead of only hiding the image view.
5. Pass nil for opusDataReceivedHandler when audio is not needed.

Notes

• The public SDK does not specify a fixed JPEG resolution or frame rate.
• JPEG mode does not require AIBudsLiveStream playback classes.
• jpegDataReceivedHandler provides compressed JPEG data, not raw pixel buffers.
• RTMP publishing is a separate AIBudsLiveStream.LiveStreamer lifecycle. Configure raw-feed mode with configure(outputURL:config:), then forward JPEG frames with pushJpegFrame(_:) and nonempty decoded PCM with pushPcmAudio(_:) only after streaming starts.