メインコンテンツまでスキップ

メディア件数の取得

接続中のデバイスへ写真、動画、音声の最新件数を要求し、更新された mediaCountInfo プロパティを読み取ります。

前提条件

メディア件数を取得する前に、次の条件を確認してください。

  • デバイスが接続済みで、安定した状態にあること
  • デバイスが DeviceInfoAPI プロトコルに対応していること

API リファレンス

フレームワーク

AIBuds.xcframework

インポート

SDK を使用するファイルで、メインフレームワークをインポートします。

Swift
import AIBuds

プロトコル

要求メソッドと結果プロパティは DeviceInfoAPI で定義されています。

Swift
protocol DeviceInfoAPI: DeviceAPI {
    /// Media file count information, including counts for photos, videos,
    /// audio, etc.
    var mediaCountInfo: MediaCountInfoModel? { get }

    /// Request to query the device media count information.
    /// - Parameters:
    ///   - completion: A closure that is called when the operation completes.
    ///   - success: `true` if the operation was successful; otherwise `false`.
    ///   - error: An `NSError` object that describes the error that occurred, or `nil` if the operation was successful.
    func requestQueryMediaCountInfo(
        _ completion: AIBudsCompletionHandler?
    )
}

インスタンスメソッド

デバイスに保存されているメディアの最新件数を要求します。

Swift
/// Request to query the device media count information.
/// - Parameters:
///   - completion: A closure that is called when the operation completes.
///   - success: `true` if the operation was successful; otherwise `false`.
///   - error: An `NSError` object that describes the error that occurred, or `nil` if the operation was successful.
func requestQueryMediaCountInfo(
    _ completion: AIBudsCompletionHandler?
)

パラメータ

パラメータ説明
completionAIBudsCompletionHandler?要求完了時に呼び出される任意の完了ハンドラー。

コールバックのパラメータ:

名前説明
successBool / BOOL要求が成功した場合は true、それ以外は false
errorNSError?要求失敗時のエラー詳細。成功時は nil

結果プロパティ:

プロパティ説明
photoCountNSNumber写真の件数。
videoCountNSNumber動画の件数。
audioCountNSNumber音声ファイルの件数。

戻り値

このメソッドの完了ハンドラーはメディア件数を返しません。要求成功後に、更新された mediaCountInfo プロパティを読み取ります。

使用例

Swift
import AIBuds

final class DeviceManager {
    weak var device: DeviceConvertible?

    func queryMediaCount() {
        guard let device = device as? DeviceInfoAPI else {
            print("Device does not support media-count queries")
            return
        }

        device.requestQueryMediaCountInfo { success, error in
            guard success else {
                print("Media-count query failed: \(error?.localizedDescription ?? "Unknown error")")
                return
            }

            guard let counts = device.mediaCountInfo else {
                print("The device did not provide media-count information")
                return
            }

            print("Photos: \(counts.photoCount)")
            print("Videos: \(counts.videoCount)")
            print("Audio files: \(counts.audioCount)")
        }
    }
}

エラー処理

  1. 更新後のプロパティを読み取る前に success を確認します。
  2. 要求に失敗した場合は、error から詳細を取得します。
  3. コールバック成功後でも、nil となる mediaCountInfo を処理します。
  4. 対象デバイスについて文書化されていない固定エラーコードを前提にしないでください。

ベストプラクティス

  1. 成功後に読み取る: 問い合わせが成功してから mediaCountInfo にアクセスします。
  2. 公開フィールドを使う: 写真、動画、音声の件数を個別に読み取ります。
  3. プロトコル対応を確認する: デバイスが DeviceInfoAPI に対応していることを確認します。
  4. メインキューで UI を更新する: 完了ハンドラーからの UIKit 更新はメインキューへ切り替えます。

注意事項

  • 完了ハンドラーが返すのは要求の状態であり、MediaCountInfoModel の結果は含まれません。
  • MediaCountInfoModel は、写真、動画、音声の件数を NSNumber として公開します。
  • SDK はこのモデルに totalCount プロパティを公開していません。
  • ファイルの撮影、取り込み、削除中は、メディア件数が変化する場合があります。