.png){kind=logo}
API - Play
- 印刷する
API - Play
- 印刷する
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
configure(with:)
Shoplive担当者から受け取ったアクセスキー（Access Key）を使用して、Shoplive iOS SDKを初期化します。
configure(with accessKey: String)パラメーター | 説明 |
|---|---|
AccessKey | Shoplive担当者から受け取ったアクセスキー(Access Key) |
サンプルコード
ShopLive.configure(with: "{AccessKey}")適用ガイド
play(data : ShopLivePlayerData)
ShopLivePlayerDataを使用して動画を再生します。
play(data : ShopLivePlayerData)ShopLivePlayerData
パラメーター | 説明 |
|---|---|
campaignKey | 再生する動画のキャンペーン(ブロードキャスト)キー(必須) |
keepWindowStateOnPlayExecuted | 再生中のプレーヤーの実行モード(PIP、Fullscreen)を維持したまま再生を開始するかどうか。デフォルト」(true) true: プレイ中のプレイヤーの実行モードにとどまります。 false: 全画面表示で実行します。 |
referrer | エントリー・パス統計を測定できるパラメーター (オプション) |
campaignHandler | ((ShopLivePlayerCampaign) -> ()))? Shopliveで配信キャンペーンの情報を受け取るためのハンドラです。 |
brandHandler | ((ShopLivePlayerBrand) -> ()))? Shopliveの配信ブランドに関する情報を受け取ることができるハンドラーです。 |
Objective-C 環境では、ShopLivePlayerDataObjc オブジェクトを使用します。
ShopLivePlayerキャンペーン
パラメーター | 説明 |
|---|---|
title | キャンペーンタイトル |
campaignStatus | キャンペーンのステータス(準備完了、オンエア、終了) |
ShopLivePlayerブランド
パラメーター | 説明 |
|---|---|
name | ブランド名 |
identifier | ブランドの一意の識別子 |
imageUrl | ブランドのサムネイル画像アドレス |
サンプルコード
ShopLive.play(data:.init(campaignKey: "{CampaignKey}", keepWindowStateOnPlayExecuted: true, referrer: "{リファラ}", campaignHandler : ((ShopLivePlayerCampaign) -> ())? = nil, brandHandler : ((ShopLivePlayerBrand) -> ())? = nil))preview(data : ShopLivePlayerData,completion:)
ShopLivePlayerData を使用してプレビューを再生します。
preview(data : ShopLivePlayerData,completion: (() -> Void)?)ShopLivePlayerData(ショップライブプレイヤーデータ)
パラメーター | 説明 |
|---|---|
campaignKey | 再生する動画のキャンペーンキー(必須) |
keepWindowStateOnPlayExecuted | 再生中のプレーヤーの実行モード(Pip、Fullscreen)を維持したまま再生を開始するかどうか。デフォルト (false) true: プレイ中のプレイヤーの実行モードにとどまります。 false: 全画面表示で実行します。 |
referrer | エントリー・パス統計を測定できるパラメーター (オプション) |
Objective-C 環境では、ShopLivePlayerDataObjc オブジェクトを使用します。
サンプルコード
ShopLive.preview(data:.init(campaignKey: "{CampaignKey}", keepWindowStateOnPlayExecuted: true, referrer: "{リファラ}"),completion : nil)アプリケーションガイド
close(actionType : ShopLiveViewHiddenActionType = .onClose)
視聴中のライブ放送を終了します。
ShopLiveViewHiddenActionType
ケース | 説明 |
|---|---|
onSwipeOut | スワイプしてプレビューを終了します |
onBtnTapped | 戻るボタンを押して終了します |
onClose | close()関数を呼び出して終了 |
onError | エラーによる終了 |
onRestoringPip | PIPからアプリに戻るときのエラー |
onNavigationHandleClose | ユーザーが nextActionTypeOnHandleNavigation の定義を持っている場合。閉じると終了です |
*サンプルコード
ShopLive.close()