API - Play

ShopLive.setAccessKey

Shoplive Android SDKを使用できるように AccessKeyを設定します。

fun setAccessKey(accessKey: String)

サンプルコード

ShopLive.setAccessKey("{AccessKey}")

• アプリケーションガイド

  Shoplive Player を開始する

ShopLive.play

CampaignKeyを使って動画を再生します。

fun play(context: Context, data: ShopLivePlayerData)
fun intentPlay(context: Context, data: ShopLivePlayerData): Intent

ShopLivePlayerData

フィールド	型	説明
campaignKey	String	再生する動画のキャンペーン（放送）キー（必須）
keepWindowStateOnPlayExecuted	Boolean	再生中のプレーヤーの実行モード（pip、fullscreen）を維持した状態で再生を開始するかどうか。デフォルト（false） true：再生中のプレーヤーの実行モードを維持します。 false：fullscreenとして実行されます。
referrer	String?	リファラ情報を測定できるパラメータ

サンプルコード

ShopLive.play(this, ShopLivePlayerData(campaignKey).apply {
    keepWindowStateOnPlayExecuted = false
    referrer = "referrer"
})

ShopLive.showPreviewPopup

キャンペーン（放送）キーを使用してプレビュービューで無音で放送を再生します。

ShopLive.play(this, ShopLivePlayerData(campaignKey).apply {
    keepWindowStateOnPlayExecuted = false
    referrer = "referrer"
})

ShopLivePlayerData

fフィールド	型	説明
campaignKey	String	再生する動画のキャンペーン（放送）キー（必須）
maxHeight	Int	最大高さ(基本180dp)
maxWidth	Int	最大幅(基本180dp)
marginTop	Int	margin Top (基本16dp)
marginBottom	Int	margin Bottom (基本16dp)
marginLeft	Int	margin Left (基本 16dp)
marginRight	Int	margin Right（基本16dp）
canTransition	Boolean	画面切り替えアニメーションかどうか
canVibrated	Boolean	プレビューを画面外に移動したときに振動するかどうか
useCloseButton	Boolean	プレビューの閉じるボタンを表示するかどうか
enabledSwipeOut	Boolean	プレビューを画面外に移動して終了させるかどうか
useCustomAction	Boolean	すぐに放送詳細画面に移動せずにonClickListenerのイベントに配信
position	ShopLivePreviewPositionConfig	プレビューの位置決め TOP_LEFT、TOP_RIGHT、BOTTOM_LEFT、BOTTOM_RIGHT
referrer	String?	リファラ情報のトラッキング
onClickListener	View.OnClickListener?	プレビュークリックイベント
onCloseListener	ShopLivePreview.OnCloseListener?	プレビュー閉じるイベント

ShopLive.setPreviewTransitionAnimation

Preview機能中にuseCustomActionを使用すると、transitionAnimationを使用できます。

fun setPreviewTransitionAnimation(activity: Activity, view: View?)

サンプルコード

ShopLive.showPreviewPopup(this, ShopLivePreviewData(campaignKey).apply {
    useCloseButton = true
    enabledSwipeOut = true
    useCustomAction = true
    onClickListener = OnClickListener { view ->
        ShopLive.setPreviewTransitionAnimation(this@MainActivity, view)
        ShopLive.play(this@MainActivity, ShopLivePlayerData(campaignKey).apply {
            referrer = viewModel.getReferrerText()
        })
    }
    onCloseListener = ShopLivePreview.OnCloseListener { view ->
        view.destroy()
    }
})

ShopLive.hidePreviewPopup

再生中のポップアッププレビューを非表示にします。

fun hidePreviewPopup()

サンプルコード

ShopLive.hidePreviewPopup()

ShopLivePreview

ShopLiveが提供するShopLivePreviewまたはShopLiveSwipePreviewコンポーネントを使用してプレビューを直接実装できます。

start(accessKey: String?, campaignKey: String?)

プレビュー再生を開始します。

fun start(accessKey: String?, campaignKey: String?)

pause

プレビューを一時停止します。

fun pause()

play

一時停止したプレビューを再生します。

fun play()

release

プレビューをオフにします。

fun release()

setLifecycleObserver

LifecyclerOwnerを登録すると、ライフサイクルに合わせてプレビュープレーヤーが自動的にプレイまたは pause できます。

fun setLifecycleObserver(owner: LifecycleOwner)

setOnCloseListener

プレビュー終了イベントを受け取ることができます。

fun setOnCloseListener(onCloseListener: OnCloseListener)

setOnDimensionRatioListener

プレビュー画面の縦横比を取得できます。

fun setOnDimensionRatioListener(onDimensionRatioListener: OnDimensionRatioListener)