JPEG-трансляция изображений

Запустите на устройстве режим JPEG-трансляции и отображайте каждое полное JPEG-изображение, полученное от SDK.

Предварительные условия

• Устройство подключено, готово и соответствует протоколу LiveStreamingAPI.
• Значение supportsJPEGImageLiveStreaming равно true.
• Интерфейс способен декодировать и заменять изображения, не блокируя обратный вызов с данными.

Справочник API

Фреймворк

AIBuds.xcframework

Импорт

Swift

Swift

import AIBuds
import UIKit

Objective-C

Objective-C

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

Свойства

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;

Метод экземпляра

Swift

Swift

/// Start JPEG image live streaming
/// - Parameters:
///   - sessionStartCompletionHandler: Session start completion handler
///   - jpegDataReceivedHandler: JPEG data received handler
///   - sessionFinishHandler: Session finish handler
func startJPEGImageLiveStreaming(
    withSessionStartCompletionHandler sessionStartCompletionHandler:
        AIBudsLiveStreamingSessionStartCompletionHandler?,
    jpegDataReceivedHandler: AIBudsLiveStreamingJpegDataReceivedHandler?,
    sessionFinishHandler: AIBudsLiveStreamingSessionFinishHandler?
)

Objective-C

Objective-C

/// Start JPEG image live streaming
/// - Parameters:
///   - sessionStartCompletionHandler: Session start completion handler
///   - jpegDataReceivedHandler: JPEG data received handler
///   - sessionFinishHandler: Session finish handler
- (void)
    startJPEGImageLiveStreamingWithSessionStartCompletionHandler:
        (AIBudsLiveStreamingSessionStartCompletionHandler _Nullable)sessionStartCompletionHandler
                                         jpegDataReceivedHandler:
                                             (AIBudsLiveStreamingJpegDataReceivedHandler _Nullable)
                                                 jpegDataReceivedHandler
                                            sessionFinishHandler:
                                                (AIBudsLiveStreamingSessionFinishHandler _Nullable)
                                                    sessionFinishHandler;

См. startJPEGImageLiveStreaming.

Значения обратных вызовов

Обработчик	Значения	Назначение
sessionStartCompletionHandler	success, error	Сообщает, удалось ли запустить сеанс трансляции.
jpegDataReceivedHandler	jpegData	Передаёт одно полное JPEG-изображение в виде Data / NSData.
sessionFinishHandler	isUserInitiatedStop, error	Сообщает итог сеанса и указывает, была ли остановка инициирована пользователем.

Возвращаемое значение

Метод не возвращает значение напрямую. Медиа и события жизненного цикла передаются через обработчики.

Примеры использования

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
        }
    },
    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;
        });
    }
    sessionFinishHandler:^(BOOL userStopped, NSError *error) {
        dispatch_async(dispatch_get_main_queue(), ^{
            [weakSelf setStreamingActive:NO];
            [weakSelf handleFinishUserStopped:userStopped error:error];
        });
    }];

Обработка ошибок

• Отбрасывайте повреждённые JPEG-данные, не заменяя последнее корректное изображение.
• Ошибка в sessionStartCompletionHandler означает, что сеанс запустить не удалось.
• В sessionFinishHandler отличайте остановку пользователем от прерывания и обрабатывайте error, если он задан.
• Не делайте выводов о потере кадров, частоте или гарантиях порядка сверх последовательности обратных вызовов SDK.

Рекомендации

1. Не сохраняйте каждый JPEG-кадр: заменяйте отображаемое изображение или используйте ограниченный буфер.
2. Выполняйте декодирование и обновление интерфейса быстро, чтобы не создавать очередь обратных вызовов.
3. При запуске нового сеанса сбрасывайте счётчики кадров и состояние отображения.
4. При выходе из функции вызывайте stopLiveStreaming(), а не просто скрывайте изображение.

Примечания

• Публичный SDK не задаёт фиксированные разрешение JPEG или частоту кадров.
• Для режима JPEG классы воспроизведения AIBudsLiveStream не требуются.
• jpegDataReceivedHandler передаёт сжатые JPEG-данные, а не необработанные буферы пикселей.