API: Etc

mute

現在再生中のビデオをミュートします。

func mute()

サンプルコード

ShopLive.mute()

unmute

現在再生中の動画のミュートを解除します。

func unmute()

サンプルコード

ShopLive.unmute()

getCampaigns

accessKey に属するキャンペーン(配信)の一覧と、各キャンペーンの現在の状態を取得します。呼び出す前に ShopLive.configure(with:) で accessKey を設定してください。iOS SDK 1.8.15 以降で利用できます。

extension ShopLive.API {

    // completion
    @discardableResult
    static func getCampaigns(_ request: ShopLiveCampaignListRequest = ShopLiveCampaignListRequest(),
                             completion: @escaping (Result<ShopLiveCampaignListResponse, ShopLiveCommonError>) -> Void) -> ShopLiveCancellable

    // async/await (iOS 13+)
    static func getCampaigns(_ request: ShopLiveCampaignListRequest = ShopLiveCampaignListRequest()) async throws -> ShopLiveCampaignListResponse
}

注意

• completion はメインスレッドで呼び出されます。

• 戻り値 ShopLiveCancellable の cancel() で進行中のリクエストをキャンセルできます。async 版は Task がキャンセルされるとリクエストも一緒にキャンセルされます。

• リクエスト・レスポンスの型は ShopliveSDKCommon モジュールに定義されています。コード内で型名を直接使う場合は import ShopliveSDKCommon が必要です。

ShopLiveCampaignListRequest

取得条件です。すべてのパラメーターは任意(オプション)で、引数なしの ShopLiveCampaignListRequest() を渡すとサーバーのデフォルト値で全状態を取得します。

ShopLiveCampaignListResponse

取得結果です。

ShopLiveCampaign

キャンペーン 1 件の情報です。

ShopLiveCampaign.Lifecycle

キャンペーンの状態と、状態遷移の時刻です。

ShopLiveCampaign.Status

キャンペーンの状態値です。サーバー値がそのままマッピングされ、未定義の値は .unknown として渡されます。

ShopLiveCampaign.Metrics

視聴指標です。.onair / .closed の状態でのみ提供されます。

エラー処理

失敗時は ShopLiveCommonError が渡されます。codes にエラーコードが入り、message は常に固定文言 Failed to fetch campaign list. Refer to the error code. です。原因は codes で判別してください。サーバーが返したエラーコードはそのまま渡されます。コードの一覧は Error codes ドキュメントを参照してください。

サンプルコード

import ShopLiveSDK
import ShopliveSDKCommon

// accessKey の設定 (アプリで最初に 1 回)
ShopLive.configure(with: "{accessKey}")

// 配信中・準備中のキャンペーンを新しい順に 20 件取得
let request = ShopLiveCampaignListRequest(page: 1,
                                          size: 20,
                                          statuses: [.onair, .ready],
                                          order: .descending)

let cancellable = ShopLive.API.getCampaigns(request) { result in
    switch result {
    case let .success(response):
        for campaign in response.campaigns {
            switch campaign.lifecycle.status {
            case .reserved:
                print("予約", campaign.title ?? "")
            case .ready:
                print(campaign.lifecycle.rehearsal ? "リハーサル中" : "準備中", campaign.title ?? "")
            case .onair:
                print(campaign.lifecycle.closingAt == nil ? "配信中" : "終了処理中", campaign.title ?? "")
            case .closed:
                print("終了", campaign.title ?? "")
            case let .unknown(raw):
                print("不明な状態", raw)
            }
        }
        if response.hasMore {
            // page を 1 増やして次のページを取得します。
        }
    case let .failure(error):
        print("getCampaigns failed:", error.codes, error.message ?? "")
    }
}

// 結果が不要になった場合 (画面を離れるなど) はリクエストをキャンセルします。
// cancellable.cancel()

サンプルコード (async/await)

// iOS 13+ — Task がキャンセルされると進行中のリクエストも一緒にキャンセルされます。
Task {
    do {
        let response = try await ShopLive.API.getCampaigns(ShopLiveCampaignListRequest(statuses: [.onair]))
        let onair = response.campaigns.filter { $0.lifecycle.closingAt == nil }
        if let campaign = onair.first {
            ShopLive.play(data: ShopLivePlayerData(campaignKey: campaign.campaignKey))
        }
    } catch let error as ShopLiveCommonError {
        print("getCampaigns failed:", error.codes)
    } catch {
        // Task のキャンセル (CancellationError) など
    }
}