Shoplive V1 モバイルSDK連携ガイド

// settings.gradle (dependencyResolutionManagement) またはプロジェクトの build.gradle
repositories {
    maven { url 'https://sdk.shoplive.cloud/maven-repo' }
    google()
    mavenCentral()
}

// app/build.gradle
dependencies {
    def shoplive_sdk_version = "1.9.0"

    implementation "cloud.shoplive:shoplive-sdk-core:$shoplive_sdk_version"
    implementation "cloud.shoplive:shoplive-common:$shoplive_sdk_version"
    implementation "cloud.shoplive:shoplive-network:$shoplive_sdk_version"
    implementation "cloud.shoplive:shoplive-exoplayer:2.19.1.20"
    // ExoPlayer の代わりに Media3 を使う場合:
    // implementation "cloud.shoplive:shoplive-media3:1.10.1.3"
}

ShopLive.setHandler(object : ShopLiveHandler() {
    override fun handleNavigation(context: Context, url: String) {
        // リンク遷移処理
    }
})

flutter pub add 'shoplive_player:^1.9.0'

# pubspec.yaml
dependencies:
  shoplive_player: ^1.9.0

# ios/Podfile(先頭)
source 'https://github.com/shoplive/pod-specs.git'
source 'https://cdn.cocoapods.org/'
platform :ios, '15.0'

cd ios && pod install --repo-update

// android/build.gradle(.kts)
allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://sdk.shoplive.cloud/maven-repo") }
    }
}

import 'package:shoplive_player/shoplive_player.dart';
import 'package:shoplive_player/shoplive_common.dart';

import ShopliveSDKCommon
import ShopLiveSDK

// 1) アプリ起動時に1回
ShopLiveCommon.setAccessKey(accessKey: "YOUR_ACCESS_KEY")

// 2) 視聴開始
ShopLive.play(data: .init(campaignKey: "YOUR_CAMPAIGN_KEY"))

// 1) アプリ起動時に1回
ShopLive.setAccessKey("YOUR_ACCESS_KEY")
ShopLive.setHandler(myHandler)

// 2) 視聴開始
ShopLive.play(this, ShopLivePlayerData("YOUR_CAMPAIGN_KEY"))

final common = ShopLiveCommon();
final player = ShopLivePlayer();

// 1) アプリ起動時に1回
common.setAccessKey(accessKey: 'YOUR_ACCESS_KEY');

// 2) 視聴開始
player.play(data: ShopLivePlayerData(campaignKey: 'YOUR_CAMPAIGN_KEY'));

git clone https://github.com/shoplive/shoplive-sdk-flutter.git
cd shoplive-sdk-flutter && git checkout 1.9.0
cd shoplive_flutter_sample/example && flutter pub get && flutter run

import ShopliveSDKCommon
import ShopLiveSDK

ShopLiveCommon.setAccessKey(accessKey: "{ACCESS_KEY}")
ShopLive.play(data: .init(campaignKey: "{CAMPAIGN_KEY}"))

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

final common = ShopLiveCommon();
final player = ShopLivePlayer();

common.setAccessKey(accessKey: "{ACCESS_KEY}");
player.play(data: ShopLivePlayerData(campaignKey: "{CAMPAIGN_KEY}"));

let previewData = ShopLivePreviewData(
    campaignKey: "{CAMPAIGN_KEY}",
    isMuted: true,
    resolution: .PREVIEW
)

ShopLive.preview(data: previewData) {
    // プレビューのタップで本再生に切り替えたい場合はここでplayを呼びます
    ShopLive.play(data: .init(campaignKey: "{CAMPAIGN_KEY}"))
}

ShopLive.showPreviewPopup(this@YourActivity, ShopLivePreviewData(campaignKey))

// 1) 先にオプションを設定し
player.setPreviewOption(
  data: ShopLivePlayerPreviewData(
    campaignKey: "{CAMPAIGN_KEY}",
    useCloseButton: true,
    enableSwipeOut: true,
    position: "BOTTOM_RIGHT",
  ),
);

// 2) 表示する(隠すときはhidePreview)
player.showPreview(campaignKey: "{CAMPAIGN_KEY}");

<!-- AndroidManifest.xml -->
<activity
    android:name=".SchemeActivity"
    android:exported="true"
    android:noHistory="true"
    android:screenOrientation="portrait">
    <intent-filter android:autoVerify="true">
        <action android:name="android.intent.action.VIEW" />

        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />

        <data
            android:scheme="https"
            android:host="xxxx"
            android:path="/yyyy" />
    </intent-filter>
</activity>

<intent-filter>
    <action android:name="android.intent.action.VIEW" />

    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />

    <data
        android:scheme="shoplive"
        android:host="live" />
</intent-filter>

// SceneDelegate
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url,
          let components = URLComponents(url: url, resolvingAgainstBaseURL: false),
          let queryItems = components.queryItems else { return }

    var campaignKey: String? = nil

    for item in queryItems {
        let value = item.value ?? ""
        switch item.name {
        case "ak":           ShopLiveCommon.setAccessKey(accessKey: value)
        case "ck":           campaignKey = value
        case "utm_source":   ShopLiveCommon.setUtmSource(utmSource: value)
        case "utm_medium":   ShopLiveCommon.setUtmMedium(utmMedium: value)
        case "utm_campaign": ShopLiveCommon.setUtmCampaign(utmCampaign: value)
        case "utm_content":  ShopLiveCommon.setUtmContent(utmContent: value)
        default:             ShopLive.addParameter(key: item.name, value: value)
        }
    }

    guard let campaignKey = campaignKey else { return }
    ShopLive.play(data: .init(campaignKey: campaignKey))
}

class SchemeActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        handle(intent)
    }

    override fun onNewIntent(intent: Intent?) {
        super.onNewIntent(intent)
        handle(intent)
    }

    private fun handle(intent: Intent?) {
        val uri = intent?.data
        if (uri == null) {
            finish()
            return
        }

        var campaignKey: String? = null

        for (name in uri.queryParameterNames) {
            val value = uri.getQueryParameter(name) ?: continue
            when (name) {
                "ak" -> ShopLiveCommon.setAccessKey(value)
                "ck" -> campaignKey = value
                "utm_source" -> ShopLive.setUtmSource(value)
                "utm_medium" -> ShopLive.setUtmMedium(value)
                "utm_campaign" -> ShopLive.setUtmCampaign(value)
                "utm_content" -> ShopLive.setUtmContent(value)
                else -> ShopLive.addParameter(name, value)
            }
        }

        // プレイヤーの起動は NEW_TASK で起動した Activity に任せる (下記の説明を参照)
        startActivity(Intent(this, MainActivity::class.java).apply {
            flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK
            putExtra("campaignKey", campaignKey)
        })
        finish()
    }
}

final common = ShopLiveCommon();
final player = ShopLivePlayer();

void handleDeepLink(Uri uri) {
  uri.queryParameters.forEach((key, value) {
    switch (key) {
      case 'ak':
        common.setAccessKey(accessKey: value);
        break;
      case 'ck':
        break; // このすぐ下で使用
      case 'utm_source':
        common.setUtmSource(utmSource: value);
        break;
      case 'utm_medium':
        common.setUtmMedium(utmMedium: value);
        break;
      case 'utm_campaign':
        common.setUtmCampaign(utmCampaign: value);
        break;
      case 'utm_content':
        common.setUtmContent(utmContent: value);
        break;
      default:
        player.addParameter(key: key, value: value);
    }
  });

  final campaignKey = uri.queryParameters['ck'];
  if (campaignKey != null) {
    player.play(data: ShopLivePlayerData(campaignKey: campaignKey));
  }
}

import ShopLiveSDK
import ShopliveSDKCommon

let user = ShopLiveCommonUser(userId: "{USER_ID}", userName: "{USER_NAME}")
ShopLiveCommon.setUser(user: user)

ShopLive.play(data: .init(campaignKey: "{CAMPAIGN_KEY}"))

val user = ShopLiveCommonUser(userId = "{USER_ID}").apply {
    userName = "{USER_NAME}"
}
ShopLive.setUser(user)

ShopLive.play(this, ShopLivePlayerData(campaignKey))

// common·player はミッション 1 で作成したインスタンスを再利用します
final user = ShopLiveCommonUser(userId: "{USER_ID}", userName: "{USER_NAME}");
common.setUser(accessKey: "{ACCESS_KEY}", user: user);

player.play(data: ShopLivePlayerData(campaignKey: "{CAMPAIGN_KEY}"));

let user = ShopLiveCommonUser(
    userId: "{USER_ID}",
    userName: "{USER_NAME}",
    age: 25,
    gender: .male,
    userScore: 80,
    custom: ["grade": "vip"])

ShopLiveCommon.setUser(user: user)
ShopLive.play(data: .init(campaignKey: "{CAMPAIGN_KEY}"))

val user = ShopLiveCommonUser(userId = "{USER_ID}").apply {
    userName = "{USER_NAME}"
    gender = ShopLiveCommonUserGender.MALE
    age = 25
    userScore = 20
}
ShopLive.setUser(user)

final user = ShopLiveCommonUser(
  userId: "{USER_ID}",
  userName: "{USER_NAME}",
  gender: ShopLiveCommonUserGender.MALE,
  userScore: 100,
  age: 25,
  custom: {"key": "value"},
);
common.setUser(accessKey: "{ACCESS_KEY}", user: user);

ShopLiveCommon.setAuthToken(authToken: "{USER_JWT}")
ShopLive.play(data: .init(campaignKey: "{CAMPAIGN_KEY}"))

ShopLiveCommon.setAuthToken("{USER_JWT}")
ShopLive.play(this, ShopLivePlayerData(campaignKey))

common.setAuthToken(userJWT: "{USER_JWT}");
player.play(data: ShopLivePlayerData(campaignKey: "{CAMPAIGN_KEY}"));

func onSetUserName(_ payload: [String: Any]) {
    payload.forEach { key, value in
        print("onSetUserName key: \(key) value: \(value)")
    }
}

override fun onSetUserName(jsonObject: JSONObject) {
    super.onSetUserName(jsonObject)
    Log.d(TAG, "userId=${jsonObject.get("userId")}, userName=${jsonObject.get("userName")}")
}

player.userInfo.listen((data) {
  print("userInfo: ${data.userInfo}");
});

func handleReceivedCommand(_ command: String, data: [String: Any]?) {
    switch command {
    case "LOGIN_REQUIRED":
        // ログイン画面に遷移 → ログイン成功後、ユーザー情報を再設定してプレイヤーを再起動
        break
    default:
        break
    }
}

override fun onReceivedCommand(context: Context, command: String, data: JSONObject) {
    when (command) {
        "LOGIN_REQUIRED" -> {
            // ログイン画面に遷移 → ログイン成功後、ユーザー情報を再設定してプレイヤーを再起動
        }
    }
}

player.receivedCommand.listen((data) {
  switch (data.command) {
    case "LOGIN_REQUIRED":
      // ログイン画面に遷移 → ログイン成功後、ユーザー情報を再設定してプレイヤーを再起動
      break;
    default:
      break;
  }
});

// ログアウト — ユーザー情報をリセット(JWT・プロフィールを消去)
ShopLiveCommon.setAuthToken(authToken: nil)
ShopLiveCommon.setUser(user: nil)

// まとめて消去 — JWT · ユーザー · accessKey をすべて消去する
ShopLiveCommon.clearAuth()
ShopLiveCommon.setAccessKey(accessKey: "{ACCESS_KEY}")   // 次の再生の前にもう一度設定

// ログアウト — ユーザー情報をリセット(JWT・プロフィールを消去)
ShopLiveCommon.setAuthToken(null)
ShopLiveCommon.setUser(null)
// ShopLive.resetUser() は setUser(null) と同じ

// まとめて消去 — ユーザー · JWT だけを消去する(accessKey は保持)
ShopLiveCommon.clearAuth()

// ログアウト — ユーザー情報をリセット
common.setAuthToken(userJWT: null);
common.clearAuth();   // Flutter の setUser は null を受け付けない

let inputFont = UIFont.systemFont(ofSize: 14, weight: .regular)
let sendButtonFont = UIFont.systemFont(ofSize: 14, weight: .medium)

ShopLive.setChatViewFont(inputBoxFont: inputFont, sendButtonFont: sendButtonFont)

val nanumGothic = ResourcesCompat.getFont(requireContext(), R.font.nanumgothic)
ShopLiveCommon.setTextTypeface(nanumGothic)

func handleNavigation(with url: URL) {
    let safari = SFSafariViewController(url: url)
    present(safari, animated: true)
}

override fun handleNavigation(context: Context, url: String) {
    val intent = Intent(this@YourActivity, WebViewActivity::class.java)
    intent.putExtra("url", url)
    startActivity(intent)
}

player.handleNavigation.listen((data) {
  launchUrl(Uri.parse(data.url), mode: LaunchMode.externalApplication);
});

func handleDownloadCoupon(with couponId: String, result: @escaping (ShopLiveCouponResult) -> Void) {
    let couponResult = ShopLiveCouponResult(
        couponId: couponId, success: true,
        message: "Coupon download success!",
        status: .SHOW, alertType: .ALERT)
    result(couponResult)
}

override fun handleDownloadCoupon(
    context: Context,
    couponId: String,
    callback: ShopLiveHandlerCallback
) {
    callback.couponResult(
        isDownloadSuccess = true,
        message = "Coupon download success!",
        couponStatus = ShopLive.CouponPopupStatus.HIDE,
        alertType = ShopLive.CouponPopupResultAlertType.ALERT
    )
}

player.handleDownloadCoupon.listen((data) async {
  await player.sendDownloadCouponResult(
    couponId: data.couponId,
    success: true,
    message: "Coupon download success!",
    popupStatus: "KEEP",
    alertType: "ALERT",
  );
});

func handleCustomAction(with id: String, type: String, payload: Any?, result: @escaping (ShopLiveCustomActionResult) -> Void) {
    let actionResult = ShopLiveCustomActionResult(
        id: id, success: true, message: "success!",
        status: .SHOW, alertType: .ALERT)
    result(actionResult)
}

override fun handleCustomAction(
    context: Context,
    id: String,
    type: String,
    payload: JSONObject,
    callback: ShopLiveHandlerCallback
) {
    callback.customActionResult(
        isSuccess = true,
        message = "success!",
        couponStatus = ShopLive.CouponPopupStatus.HIDE,
        alertType = ShopLive.CouponPopupResultAlertType.ALERT
    )
}

player.handleCustomAction.listen((data) async {
  await player.sendCustomActionResult(
    id: data.id,
    success: true,
    message: "success!",
    popupStatus: "SHOW",
    alertType: "ALERT",
  );
});

// ShopLiveSDKDelegate
func handleReceivedCommand(_ command: String, data: [String: Any]?) {
    switch command {
    case "CLICK_PRODUCT_DETAIL":
        // data: 選択した商品情報
        break
    case "CLICK_PRODUCT_CART":
        // data: カートに入れた商品情報
        break
    default:
        break
    }
}

// ShopLiveHandler
override fun onReceivedCommand(context: Context, command: String, data: JSONObject) {
    when (command) {
        "CLICK_PRODUCT_DETAIL" -> {
            // data: 選択した商品情報
        }
        "CLICK_PRODUCT_CART" -> {
            // data: カートに入れた商品情報
        }
    }
}

final player = ShopLivePlayer();

player.receivedCommand.listen((event) {
  switch (event.command) {
    case 'CLICK_PRODUCT_DETAIL':
      // event.data: 選択した商品情報
      break;
    case 'CLICK_PRODUCT_CART':
      // event.data: カートに入れた商品情報
      break;
  }
});

func handleNavigation(with url: URL) {
    // url: 選択した商品またはバナーに設定された詳細情報 URL
    print("handleNavigation \(url)")
}

override fun handleNavigation(context: Context, url: String) {
    Log.d(TAG, "handleNavigation url=$url")
}

final player = ShopLivePlayer();

player.handleNavigation.listen((event) {
  debugPrint("handleNavigation : ${event.url}");
});

ShopLive.hookNavigation { url in
    // url: 選択した商品またはバナーに設定された詳細情報 URL
    print("hookNavigation \(url)")
}

// URI Scheme
let scheme = "{your_scheme}://{your_host}?ak=xxx&ck=yyy"
ShopLive.setShareScheme(scheme, shareDelegate: nil)

// または Web URL
ShopLive.setShareScheme("https://www.share_link.com/?ak=xxx&ck=yyy", shareDelegate: nil)

// URI Scheme
val scheme = "{your_scheme}://{your_host}?ak=xxx&ck=yyy"
ShopLive.setShareScheme(scheme)

// または Web URL
ShopLive.setShareScheme("https://www.share_link.com/?ak=xxx&ck=yyy")

final player = ShopLivePlayer();

player.setShareScheme(
  shareSchemeUrl: "{your_scheme}://{your_host}?ak=xxx&ck=yyy",
);

// 1) 共有データを受け取るデリゲートを指定
ShopLive.setShareScheme(scheme, shareDelegate: self)

// 2) デリゲートでアプリの共有 UI を表示する
extension MainViewController: ShopLivePlayerShareDelegate {
    func handleShare(data: ShopLivePlayerShareData) {
        guard let urlString = data.url, let url = URL(string: urlString) else { return }

        let activityVC = UIActivityViewController(activityItems: [url],
                                                  applicationActivities: nil)
        ShopLive.viewController?.present(activityVC, animated: true, completion: nil)
    }
}

// ShopLiveHandler — オーバーライドしなければ SDK が標準の共有シートを表示します
override fun handleShare(context: Context, data: ShopLivePlayerShareData) {
    val inflater = getSystemService(LAYOUT_INFLATER_SERVICE) as LayoutInflater
    val view = inflater.inflate(R.layout.custom_share_dialog, null)

    AlertDialog.Builder(context)
        .setView(view)
        .create()
        .show()
}

// PIP 全体を許可するか (アプリ内 PIP · OS PIP 共通の前提)
ShopLive.setEnabledPictureInPictureMode(isEnabled: true)

// サイズ・位置・角丸・閉じるボタンをまとめて指定
let config = ShopLiveInAppPipConfiguration(
    useCloseButton: true,
    pipPosition: .bottomRight,
    enableSwipeOut: true,
    pipSize: ShopLiveInAppPipSize(pipMaxSize: 200),
    pipRadius: 10,
    pipPinPositions: [.topLeft, .topRight, .bottomLeft, .bottomRight],
    closeButtonConfig: ShopLiveCloseButtonConfig(position: .topRight, width: 30, height: 30, offsetX: 3, offsetY: 3, color: .white)
)
ShopLive.setInAppPipConfiguration(config: config)

final player = ShopLivePlayer();

// アプリ内 PIP とプレビューウィンドウは同じウィンドウなので、設定も同じ呼び出し 1 つで行います
player.setPreviewOption(
  data: ShopLivePlayerPreviewData(
    campaignKey: 'YOUR_CAMPAIGN_KEY',
    useCloseButton: true,
    enableSwipeOut: true,
    pipRadius: 10,
    pipMaxSize: 400,
    position: 'BOTTOM_RIGHT',
  ),
);

ShopLive.setEnabledOSPictureInPictureMode(isEnabled: true)

// OS PIP への移行を許可 (デフォルト true)
ShopLive.setEnabledPictureInPictureMode(true)

// PIP ウィンドウの比率 — 指定しなければ 9:16
// RATIO_1X1 / RATIO_1X2 / RATIO_2X3 / RATIO_3X4 / RATIO_9X16
ShopLive.setPIPRatio(ShopLivePIPRatio.RATIO_9X16)

ShopLivePermissionManager.request(this, ShopLivePermissionType.DRAW_OVERLAY) { hasPermission ->
    // hasPermission == true ならオーバーレイ権限が許可された状態です
}

// app/build.gradle
implementation "cloud.shoplive:shoplive-permission:$shoplive_sdk_version"

// アプリ内 PIP へ切り替え
ShopLive.startPictureInPicture()

// 全画面表示に戻る
ShopLive.stopPictureInPicture()

// OS PIP へ切り替え — オーバーレイ権限案内画面が閉じるのを待つ必要があれば true
ShopLive.startPictureInPicture(shouldDelayForOverlayPermissionFlow = false)

// 全画面表示に戻る
ShopLive.stopPictureInPicture()

final player = ShopLivePlayer();

player.startPictureInPicture();
player.stopPictureInPicture();

// 画面端で PIP が入り込まないようにする領域
let offsetApplied = ShopLive.setPictureInPictureFloatingOffset(
    offset: UIEdgeInsets(top: 60, left: 0, bottom: 90, right: 0))

// PIP 自体に設ける余白
let paddingApplied = ShopLive.setPictureInPicturePadding(
    padding: UIEdgeInsets(top: 8, left: 8, bottom: 8, right: 8))

let previewData = ShopLivePreviewData(
    campaignKey: "YOUR_CAMPAIGN_KEY",
    keepWindowStateOnPlayExecuted: true,
    referrer: nil,
    isMuted: true,
    isEnabledVolumeKey: false,
    resolution: .PREVIEW
)

ShopLive.preview(data: previewData) {
    // プレビューウィンドウをタップしたときに全画面へ切り替えるには
    ShopLive.play(data: .init(campaignKey: "YOUR_CAMPAIGN_KEY"))
}

ShopLive.showPreviewPopup(this, ShopLivePreviewData("YOUR_CAMPAIGN_KEY").apply {
    useCloseButton = true
    enabledSwipeOut = true
    resolutionType = ShopLivePreviewResolutionType.LIVE

    onClickListener = View.OnClickListener { view ->
        // プレビュー → プレイヤー遷移アニメーション
        ShopLive.setPreviewTransitionAnimation(this@MainActivity, view)
        ShopLive.play(this@MainActivity, ShopLivePlayerData("YOUR_CAMPAIGN_KEY"))
    }
})

final player = ShopLivePlayer();

// 1) 先にオプションを指定
player.setPreviewOption(
  data: ShopLivePlayerPreviewData(
    campaignKey: 'YOUR_CAMPAIGN_KEY',
    useCloseButton: true,
    enableSwipeOut: true,
    pipRadius: 10,
    pipMaxSize: 400,
    position: 'BOTTOM_RIGHT',
  ),
);

// 2) プレビュー開始
player.showPreview(campaignKey: 'YOUR_CAMPAIGN_KEY');

player.hidePreview();

// オプションを 1 回保存 — campaignKey は showPreviewPopup 呼び出し時の値で上書きされます
ShopLive.setPreviewOptions(ShopLivePreviewData("YOUR_CAMPAIGN_KEY").apply {
    useCloseButton = true
    enabledSwipeOut = true
})

// 表示するときは campaignKey のみ
ShopLive.showPreviewPopup(this, "YOUR_CAMPAIGN_KEY")

<cloud.shoplive.sdk.ShopLivePreview
    android:id="@+id/preview"
    android:layout_width="120dp"
    android:layout_height="180dp" />

import ShopLiveSDK
import ShopliveSDKCommon

final class PreviewCell: UITableViewCell {
    private var preview: ShopLivePlayerPreview?

    func configure(campaignKey: String) {
        let preview = ShopLivePlayerPreview()
        preview.translatesAutoresizingMaskIntoConstraints = false
        contentView.addSubview(preview)
        NSLayoutConstraint.activate([
            preview.topAnchor.constraint(equalTo: contentView.topAnchor),
            preview.leadingAnchor.constraint(equalTo: contentView.leadingAnchor),
            preview.widthAnchor.constraint(equalToConstant: 120),
            preview.heightAnchor.constraint(equalToConstant: 180)
        ])
        self.preview = preview

        preview.action(.initialize)
        preview.resultHandler = { result in
            switch result {
            case .didChangeCampaignStatus(let status):
                print(status)
            case .onError(let code, let message):
                print(code, message)
            case .handleReceivedCommand(let command, let payload):
                print(command, payload ?? [:])
            default:
                break   // その他のケースはプレビューコンポーネントのリファレンスを参照
            }
        }
        // グローバルの accessKey をこの値に置き換える
        preview.action(.start(accessKey: "{ACCESS_KEY}", campaignKey: campaignKey, referrer: nil))
    }

    override func prepareForReuse() {
        super.prepareForReuse()
        preview?.action(.close)   // セル再利用時の後始末 — 親ビューから取り除く
        preview = nil
    }
}

// owner はアダプタのコンストラクタで受け取った LifecycleOwner (ホストの Activity/Fragment) です
class PreviewAdapter(
    private val owner: LifecycleOwner,
    private val campaignKeys: List<String>,
) : RecyclerView.Adapter<PreviewAdapter.ViewHolder>() {

    override fun getItemCount() = campaignKeys.size

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder {
        val view = LayoutInflater.from(parent.context)
            .inflate(R.layout.item_preview, parent, false)
        return ViewHolder(view)
    }

    override fun onBindViewHolder(holder: ViewHolder, position: Int) {
        holder.onBind(campaignKeys[position])
    }

    // RecyclerView がセルをアタッチ・デタッチするタイミングで再生を開始・解除します
    override fun onViewAttachedToWindow(holder: ViewHolder) {
        super.onViewAttachedToWindow(holder)
        holder.onViewAttachedToWindow()
    }

    override fun onViewDetachedFromWindow(holder: ViewHolder) {
        holder.onViewDetachedFromWindow()
        super.onViewDetachedFromWindow(holder)
    }

    inner class ViewHolder(view: View) : RecyclerView.ViewHolder(view) {
        private val preview: ShopLivePreview = view.findViewById(R.id.preview)

        fun onBind(campaignKey: String) {
            preview.initializePlayer()
            preview.setLifecycleObserver(owner)
            preview.campaignKey = campaignKey
            preview.setMuted(true)
        }

        fun onViewAttachedToWindow() {
            preview.start() // ミッション 1 で ShopLiveCommon.setAccessKey により設定済みの accessKey を使います
        }

        fun onViewDetachedFromWindow() {
            preview.release()
        }
    }
}

import ShopliveSDKCommon

let products = [
    ShopLiveConversionProductData(
        productId: "productId",
        customerProductId: "customerProductId",
        sku: "sku",
        url: "url",
        purchaseQuantity: 1,
        purchaseUnitPrice: 1000.0)
]

ShopLiveEvent.sendConversionEvent(data: .init(
    type: "purchase",
    products: products,
    orderId: "orderId",
    referrer: "referrer",
    custom: ["campaignKey": "campaignKey"]))

ShopLiveEvent.sendConversionEvent(
    ShopLiveConversionData(
        "purchase",
        products = listOf(
            ShopLiveConversionProductData(
                productId = "productId",
                customerProductId = "customerProductId",
                sku = "sku",
                url = "url",
                purchaseQuantity = 1,
                purchaseUnitPrice = 1000.0,
            )
        ),
        orderId = "orderId",
        referrer = "referrer",
        custom = mapOf("campaignKey" to "campaignKey"),
    )
)

// ログインユーザー — 視聴時と同じ方式
ShopLiveCommon.setUser(user: ShopLiveCommonUser(userId: "{USER_ID}"))
// またはバックエンドが署名した JWT
ShopLiveCommon.setAuthToken(authToken: "{USER_JWT}")

// 非ログイン — アプリが管理する端末識別子がある場合のみ
ShopLiveCommon.setAnonId(anonId: "{DEVICE_ID}")

// ログインユーザー — 視聴時と同じ方式
ShopLive.setUser(ShopLiveCommonUser(userId = "{USER_ID}"))
// またはバックエンドが署名した JWT
ShopLiveCommon.setAuthToken("{USER_JWT}")

// 非ログイン — アプリが管理する端末識別子がある場合のみ
ShopLiveCommon.setAnonId("{DEVICE_ID}")

// ShopLiveSDKDelegate
private var isMuted = false

func onEvent(name: String, feature: ShopLiveLog.Feature, campaign: String, payload: [String: Any]) {
    switch name {
    case "video_muted":
        isMuted = true
    case "video_unmuted":
        isMuted = false
    default:
        break
    }
}

// ShopLiveHandler
private var isMuted = false

override fun onEvent(context: Context, data: ShopLiveLog.Data) {
    when (data.name) {
        "video_muted" -> isMuted = true
        "video_unmuted" -> isMuted = false
    }
}

final player = ShopLivePlayer();
bool isMuted = false;

player.log.listen((data) {
  switch (data.name) {
    case "video_muted":
      isMuted = true;
      break;
    case "video_unmuted":
      isMuted = false;
      break;
  }
});

ShopLive.setMuteWhenPlayStart(isMuted)
ShopLive.play(data: .init(campaignKey: "{CAMPAIGN_KEY}"))

ShopLive.setMuteWhenPlayStart(isMuted)
ShopLive.play(this, ShopLivePlayerData("{CAMPAIGN_KEY}"))

final player = ShopLivePlayer();

player.setMuteWhenPlayStart(isMute: isMuted);
player.play(data: ShopLivePlayerData(campaignKey: "{CAMPAIGN_KEY}"));

// 上の表の値のうち一つを指定します (.PIP · .KEEP · .CLOSE)
ShopLive.setNextActionOnHandleNavigation(actionType: .PIP)

// 上の表の値のうち一つを指定します (PIP · KEEP · CLOSE)
ShopLive.setNextActionOnHandleNavigation(ActionType.PIP)

ShopLive.sendCommandMessage(
    command: "SET_BRAND_FAVORITE",
    payload: ["identifier": "brand-identifier", "favorite": true])

ShopLive.sendCommandMessage(
    "SET_BRAND_FAVORITE",
    mapOf("identifier" to "brand-identifier", "favorite" to true)
)

func handleReceivedCommand(_ command: String, data: [String: Any]?) {
    switch command {
    case "ON_CLICK_BRAND_FAVORITE_BUTTON":
        guard let identifier = data?["identifier"] as? String else {
            return
        }
        // アプリ・バックエンドでフォローを処理し、確定した最終状態をそのまま返します
        updateFavorite(identifier: identifier) { isFavorite in
            ShopLive.sendCommandMessage(
                command: "SET_BRAND_FAVORITE",
                payload: ["identifier": identifier, "favorite": isFavorite])
        }
    case "ON_CHANGED_BRAND_FAVORITE":
        // フォロー状態が変わった結果を通知します
        break
    default:
        break
    }
}

override fun onReceivedCommand(context: Context, command: String, data: JSONObject) {
    when (command) {
        "ON_CLICK_BRAND_FAVORITE_BUTTON" -> {
            val identifier = data.getString("identifier")
            // アプリ・バックエンドでフォローを処理し、確定した最終状態をそのまま返します
            updateFavorite(identifier) { isFavorite ->
                ShopLive.sendCommandMessage(
                    "SET_BRAND_FAVORITE",
                    mapOf("identifier" to identifier, "favorite" to isFavorite)
                )
            }
        }
        "ON_CHANGED_BRAND_FAVORITE" -> {
            // フォロー状態が変わった結果を通知します
            val identifier = data.getString("identifier")
        }
    }
}

let configuration = WKWebViewConfiguration()
configuration.allowsInlineMediaPlayback = true
let webView = WKWebView(frame: view.bounds, configuration: configuration)

webView.webViewClient = object : WebViewClient() {
    override fun shouldOverrideUrlLoading(
        view: WebView?,
        request: WebResourceRequest?
    ): Boolean {
        // 別のスキームがある場合のみここで処理します
        val url = request?.url ?: return super.shouldOverrideUrlLoading(view, request)
        if (url.toString().startsWith("market")) {
            val intent = Intent(Intent.ACTION_VIEW).apply {
                data = url
            }
            startActivity(intent)
            return true
        }
        return super.shouldOverrideUrlLoading(view, request)
    }
}

webView.webChromeClient = object : WebChromeClient() {
    override fun onCreateWindow(
        view: WebView?,
        isDialog: Boolean,
        isUserGesture: Boolean,
        resultMsg: Message?
    ): Boolean {
        view ?: return true
        resultMsg ?: return true
        val subWebView = WebView(view.context)
        subWebView.webViewClient = object : WebViewClient() {
            // API 23 以下の端末をサポートする場合は String オーバーロードも実装してください
            override fun shouldOverrideUrlLoading(view: WebView?, url: String?): Boolean {
                url ?: return false
                if (url.startsWith("http")) {
                    webView.loadUrl(url)
                }
                return true
            }
            override fun shouldOverrideUrlLoading(
                view: WebView?,
                request: WebResourceRequest?
            ): Boolean {
                val url = request?.url?.toString() ?: return false
                if (url.startsWith("http")) {
                    webView.loadUrl(url)
                }
                return true
            }
        }
        val viewTransport = (resultMsg.obj as? WebView.WebViewTransport) ?: return true
        viewTransport.webView = subWebView
        resultMsg.sendToTarget()
        return true
    }
}

val intent = Intent(Intent.ACTION_VIEW).apply {
    data = Uri.parse(url)
}
startActivity(intent)

ShopLive.indicatorColor = UIColor.purple

ShopLive.setLoadingProgressColor(Color.RED)

var images: [UIImage] = []

for i in 1...11 {
    images.append(.init(named: "loading\(i)")!)
}

ShopLive.setLoadingAnimation(images: images)

ShopLive.setLoadingAnimation(R.drawable.progress_animation)

<?xml version="1.0" encoding="utf-8"?>
<animation-list xmlns:android="http://schemas.android.com/apk/res/android"
    android:oneshot="false">

    <item android:drawable="@drawable/loading1" android:duration="100" />
    <item android:drawable="@drawable/loading2" android:duration="100" />
    <item android:drawable="@drawable/loading3" android:duration="100" />
    <item android:drawable="@drawable/loading4" android:duration="100" />
</animation-list>

// イヤホンが抜けても再生を継続 (デフォルト false — 停止)
ShopLive.setKeepPlayVideoOnHeadphoneUnplugged(true)
// 再生は継続するがミュートにする
ShopLive.setKeepPlayVideoOnHeadphoneUnplugged(true, isMute: true)
print(ShopLive.isKeepPlayVideoOnHeadPhoneUnplugged())

// 通話が終わると自動的に再生を再開 (iOS のデフォルト false — 停止したまま)
ShopLive.setAutoResumeVideoOnCallEnded(true)
print(ShopLive.isAutoResumeVideoOnCallEnded())

// イヤホンが抜けても再生を継続 (デフォルト false — 停止)
ShopLive.setKeepPlayVideoOnHeadphoneUnplugged(true, false)
// 再生は継続するがミュートにする
ShopLive.setKeepPlayVideoOnHeadphoneUnplugged(true, true)

// 通話が終わると自動的に再生を再開 (Android のデフォルト true)
ShopLive.setAutoResumeVideoOnCallEnded(false)

handleNavigation(with url: URL)

handleNavigation(context, url: String)

handleNavigation → {url}

handleDownloadCoupon(with couponId: String, result: (ShopLiveCouponResult) -> Void)

handleDownloadCoupon(context, couponId: String, callback: ShopLiveHandlerCallback)

handleDownloadCoupon → {couponId}

handleCustomAction(with id: String, type: String, payload: Any?, result: (ShopLiveCustomActionResult) -> Void)

handleCustomAction(context, id: String, type: String, payload: JSONObject, callback: ShopLiveHandlerCallback)

handleCustomAction → {id, type, payload: String}

handleChangeCampaignStatus(status: String)

onChangeCampaignStatus(context, campaignStatus: String)

changeCampaignStatus → {campaignStatus}

handleCampaignInfo(campaignInfo: [String: Any])

onCampaignInfo(campaignInfo: JSONObject)

campaignInfo → {campaignInfo: Map}

handleChangedPlayerStatus(status: String)

onChangedPlayerStatus(isPipMode: Boolean, playerLifecycle: PlayerLifecycle)

changedPlayerStatus

onSetUserName(_ payload: [String: Any])

onSetUserName(jsonObject: JSONObject)

userInfo → {userInfo: Map}

handleError(code: String, message: String)

onError(context, error: ShopLiveCommonError)

error → {code, message}

handleReceivedCommand(_ command: String, data: [String: Any]?)

onReceivedCommand(context, command: String, data: JSONObject)

receivedCommand → {command, data: Map}

handleCommand(_ command: String, with payload: Any?)

playerPanGesture(state: UIGestureRecognizer.State, position: CGPoint)

handlePreviewTouchGesture()

onEvent(name: String, feature: ShopLiveLog.Feature, campaign: String, payload: [String: Any])

onEvent(context, data: ShopLiveLog.Data)

log → {name, feature, campaignKey, payload: Map}

ShopLivePlayerShareDelegate.handleShare(data: ShopLivePlayerShareData)

handleShare(context, data: ShopLivePlayerShareData)

onUserCloseAction(isPipMode: Boolean)

ShopLive.setCloseHandler(_ handler: (ShopLiveViewHiddenActionType) -> Void)
ShopLive.setPreviewCloseHandler(_ handler: (ShopLiveViewHiddenActionType) -> Void)

onClose(type: ShopLivePresentType, reason: ShopLiveViewHiddenActionType)

previewClose → ShopLivePreviewClose {campaignKey, reason}

ShopLivePlayerPreviewDelegate.handlePlaybackEvent(_ event: ShopLivePreviewPlaybackEvent)

ShopLivePreview.setOnPlaybackEventListener(OnPlaybackEventListener)

// クーポン結果。handleDownloadCoupon の result に渡す
ShopLiveCouponResult(couponId: String,
                     success: Bool,
                     message: String?,
                     status: ShopLiveResultStatus,      // SHOW / HIDE / KEEP
                     alertType: ShopLiveResultAlertType) // ALERT / TOAST

// カスタムアクション結果。handleCustomAction の result に渡す
ShopLiveCustomActionResult(id: String,
                           success: Bool,
                           message: String?,
                           status: ShopLiveResultStatus,
                           alertType: ShopLiveResultAlertType)

// どちらも SDK が渡した callback オブジェクトに入れる
callback.couponResult(
    isDownloadSuccess = true,
    message = successMessage,
    couponStatus = ShopLive.CouponPopupStatus.HIDE,          // SHOW / HIDE / KEEP
    alertType = ShopLive.CouponPopupResultAlertType.TOAST    // ALERT / TOAST
)

callback.customActionResult(
    isSuccess = true,
    message = successMessage,
    couponStatus = ShopLive.CouponPopupStatus.HIDE,
    alertType = ShopLive.CouponPopupResultAlertType.ALERT
)

// Flutter だけはストリームではなく別メソッドで結果を送る
await ShopLivePlayer().sendDownloadCouponResult(
  couponId: couponId,
  success: true,
  message: successMessage,
  popupStatus: "HIDE",   // SHOW / HIDE / KEEP
  alertType: "TOAST",    // ALERT / TOAST
);

await ShopLivePlayer().sendCustomActionResult(
  id: id,
  success: true,
  message: successMessage,
  popupStatus: "HIDE",
  alertType: "ALERT",
);

// レガシー ― ユーザー情報。代替: ShopLiveCommon.setUser(user:accessKey:)。コンストラクタパラメータのラベルはuserName:(原文のname:はコンパイルできません) · ミッション3
ShopLive.user: ShopLiveCommonUser?

// レガシー ― ユーザー情報 JWT(セキュア認証)。代替: ShopLiveCommon.setAuthToken(authToken:) · ミッション3
ShopLive.authToken: String?

// レガシー(v2で削除予定) ― with accessKey: String 1つでAccessKeyを設定。代替: ShopLiveCommon.setAccessKey(accessKey:)
ShopLive.configure

// setAuthToken で設定した JWT を取得。なければ setUser で生成された JWT · ミッション3
ShopLiveCommon.getAuthToken() -> String?

// ユーザー情報を設定(accessKeyはすでに設定された値をそのまま使用)。accessKeyを一緒に指定するにはShopLiveCommon.setUser(accessKey, user) · ミッション3
ShopLive.setUser(user: ShopLiveCommonUser?)

// レガシー — ShopLiveUser型はもう使用しません。代替: 上のShopLiveCommonUserバージョン
ShopLive.setUser(user: ShopLiveUser)

// ユーザー情報 JWT を設定(セキュア認証) · ミッション3
ShopLive.setAuthToken(authToken: String)

// 上の設定値を取得 · ミッション3
ShopLive.getAuthToken(): String?

// レガシー ― AccessKeyを設定。代替: ShopLive.setAccessKey(accessKey:)
ShopLive.configure(accessKey: String)

// アプリ内PIP・OS PIPへの入場をまとめて許可するかどうか(オフにするとプレーヤー離脱時の自動PIP切り替えもされない) · デフォルト値 true · ミッション8
setEnabledPictureInPictureMode(isEnabled: Bool)

// アプリ内 PIP のサイズ・位置・閉じるボタンの見た目を細かく設定(閉じるボタンの表示は config.useCloseButton プロパティで指定し、レガシーの useCloseButton(_:) を置き換え。閉じるボタンの見た目 = closeButtonConfig)。以前の個別設定 API より優先して適用 · ミッション8
setInAppPipConfiguration(config: ShopLiveInAppPipConfiguration)

// 指定されたPIP設定・映像比から実際のレンダーサイズを計算
getPreviewSize(inAppPipConfiguration: ShopLiveInAppPipConfiguration, videoRatio: CGSize) -> CGSize

// Preview画面の上にカスタムビューを重ねる(閉じるボタンは別途オフにする必要あり)
addSubViewToPreview(subView: UIView)

// フルスクリーン → アプリ内PIPへ切り替え · デフォルト値 scale 0.4 · ミッション8
startPictureInPicture(with position: ShopLive.PipPosition, scale: CGFloat) / startPictureInPicture()

// PIP → フルスクリーンへ切り替え · ミッション8
stopPictureInPicture()

// OS PIPで離脱してアプリに戻る際、最後の再生状態(PIP/フルスクリーン)を維持するか、常にフルスクリーンに戻すか · デフォルト値 false(常にフルスクリーン) · ミッション8
setKeepWindowStyleOnReturnFromOsPip(_ keep: Bool)

// 上の設定値を取得 · ミッション8
isKeepWindowStyleOnReturnFromOsPip() -> Bool

// OS PIPだけを別途許可するかどうか(アプリ内PIPはこの設定と無関係) · デフォルト値 true · ミッション8
setEnabledOSPictureInPictureMode(isEnabled: Bool)

// アプリ内PIPが移動できる領域の上下左右パディング。値が無効な場合はfalseを返しデフォルト値を適用 · デフォルト値 top/left/right/bottom 20 · ミッション8
setPictureInPicturePadding(padding: UIEdgeInsets) -> Bool

// アプリ内PIPが移動可能な領域自体をオフセットで制限。値が無効な場合はfalseを返す · ミッション8
setPictureInPictureFloatingOffset(offset: UIEdgeInsets) -> Bool

// レガシー ― Preview・PIPモードで閉じるボタンを表示するかどうか。代替: setInAppPipConfiguration(config:)のuseCloseButtonプロパティ
useCloseButton(_ use: Bool)

// プレーヤー離脱時に自動的にPIPへ切り替わるかどうか · ミッション8
ShopLive.setEnabledPictureInPictureMode(isEnabled: Boolean)

// PIP画面開始時のデフォルトの画面比率(RATIO_1X1 / 1X2 / 2X3 / 3X4 / 9X16) · ミッション8
ShopLive.setPIPRatio(pipRatio: ShopLivePIPRatio)

// 戻るボタンで画面を離れる際、終了の代わりにPIPへ切り替えるかどうか · ミッション8
ShopLive.setEnterPipModeOnBackPressed(isEnterPipMode: Boolean)

// フルスクリーン → PIPへ切り替え。レガシーの引数なし形式のstartPictureInPicture()はdeprecated(このシグネチャでshouldDelayForOverlayPermissionFlow = falseが呼ばれる) · ミッション8
ShopLive.startPictureInPicture(shouldDelayForOverlayPermissionFlow: Boolean)

// PIP → フルスクリーンへ切り替え · ミッション8
ShopLive.stopPictureInPicture()

// 戻るボタンで画面を離れる際、終了の代わりにPIPへ切り替えるかどうか · ミッション8
ShopLivePlayer().setEnterPipModeOnBackPressed(isEnterPipMode: bool)

// フルスクリーン ↔ PIP切り替え · ミッション8
ShopLivePlayer().startPictureInPicture() / stopPictureInPicture()

// Preview・PIPモードで閉じるボタンを表示するかどうか
ShopLivePlayer().useCloseButton(canUse: bool)

// 共有ポップアップに渡すscheme/URLを指定。shareDelegateを渡すと、システム共有の代わりにカスタム共有UIを自分で実装 · ミッション7
setShareScheme(_ scheme: String?, shareDelegate: ShopLivePlayerShareDelegate?)

// 商品・バナー選択時にURLだけをクロージャで横取りする ― 登録するとhandleNavigationデリゲートは呼ばれない(iOS専用) · ミッション6
hookNavigation(navigation: @escaping (URL) -> Void)

// 商品・バナーリンク選択後のプレーヤーの次の動作(PIP/KEEP/CLOSE)を指定 · デフォルト値 PIP · ミッション11
setNextActionOnHandleNavigation(actionType: ActionType)

// 上の設定値を取得 · ミッション11
getNextActionTypeOnHandleNavigation() -> ActionType

// 共有ポップアップに渡すscheme/URLを指定 · ミッション7
ShopLive.setShareScheme(shareSchemeUrl: String?)

// 商品・バナーリンク選択後のプレーヤーの次の動作(PIP/KEEP/CLOSE)を指定 · ミッション11
ShopLive.setNextActionOnHandleNavigation(type: ActionType)

// 共有時に渡すscheme/URLを指定 · ミッション7
ShopLivePlayer().setShareScheme(shareSchemeUrl: String)

// 商品・バナーリンク選択後の次の動作(show/hide/keep)を指定 ― ネイティブには文字列として渡されますが、Androidの受信側が整数として読み取るため実際には無視される(ミッション11参照) · ミッション11
ShopLivePlayer().setNextActionOnHandleNavigation(type: ShopLiveActionType)

// チャット入力欄・送信ボタンのフォントを指定 · デフォルト値 システムフォント · ミッション4
setChatViewFont(inputBoxFont: UIFont?, sendButtonFont: UIFont?)

// 映像のローディング進捗を画像シーケンスアニメーションで表示
setLoadingAnimation(images: [UIImage])

// 通常のaddSubviewではShopLiveのポリシー上追加されないビューを強制的に載せる
playerWindow?.forceAddSubView(_:)

// フルスクリーン再生中のステータスバー表示/非表示 (InAppPipでは常に自動的に表示) · デフォルト値 true(表示)
setVisibleStatusBar(isVisible: Bool)

// ローディングインジケーターの色を指定 · ミッション11
indicatorColor: UIColor

// 映像の縦横比の維持方式を指定
setResizeMode(mode: ShopLiveResizeMode)

// ローディングプログレスバーの色を指定 · ミッション11
ShopLive.setLoadingProgressColor(@ColorInt colorInt: Int)

// ローディングプログレスバーを画像アニメーションとして指定(0にすると解除) · ミッション11
ShopLive.setLoadingAnimation(@DrawableRes drawableRes: Int)

// チャット入力欄・送信ボタンのフォントを共通で指定 · ミッション4
ShopLive.setChatViewTypeface(typeface: Typeface?)

// 画面のステータスバーの表示/非表示 · デフォルト値 false(非表示)
ShopLive.setVisibleStatusBar(isVisible: Boolean)

// ステータスバー・ナビゲーションバーの色を変更。play の前に呼び出す。ShopLivePlayerSystemBarColorData(statusBarColor · navigationBarColor はデフォルト黒 DEFAULT_COLOR、isTaskBarOpened はデフォルト false)
ShopLive.setSystemBarColor(data: ShopLivePlayerSystemBarColorData)

// 上の色設定をデフォルトに戻す。play の前に呼び出す
ShopLive.clearSystemBarColor()

// プレーヤー画面の上にカスタムDialogFragmentを表示・終了
ShopLive.showDialogFragment(dialogFragment: DialogFragment?) / closeDialogFragment()

// 配信画面のスクリーンショットを許可するかどうか
ShopLive.setPlayerScreenCaptureEnabled(isEnabled: Boolean)

// 映像の縦横比の維持方式を指定 · デフォルト値 CENTER_CROP
ShopLive.setResizeMode(resizeMode: ShopLiveResizeMode)

// 映像の縦横比の維持方式を指定
ShopLivePlayer().setResizeMode(mode: ShopLiveResizeMode)

// 通話終了後に映像に戻ったとき自動再生するかを設定 · デフォルト値 false(自動再生しない) · ミッション11
setAutoResumeVideoOnCallEnded(_ autoResume: Bool)

// 上の設定値を取得 · ミッション11
isAutoResumeVideoOnCallEnded() -> Bool

// イヤホン(ヘッドセット)の接続が切れたとき再生を続けるか(keepPlay、必須引数)、続ける場合はミュートにするか(isMute)。呼び出さない場合、SDKのデフォルト動作は停止 · デフォルト値 isMuteのデフォルト値はfalse · ミッション11
setKeepPlayVideoOnHeadphoneUnplugged(_ keepPlay: Bool, isMute: Bool = false)

// 上の設定値を取得 · ミッション11
isKeepPlayVideoOnHeadPhoneUnplugged() -> Bool

// プレーヤー開始時にミュートするかどうか · デフォルト値 false(サウンドオン) · ミッション11
setMuteWhenPlayStart(_ mute: Bool)

// 他アプリのオーディオと一緒に再生するか、外部オーディオ再生時に一時停止するか · デフォルト値 true(一緒に再生)
setMixWithOthers(isMixAudio: Bool)

// AVAudioSession.Categoryを直接指定(iOS専用のオーディオセッション制御)
setAudioSessionCategory(category: AVAudioSession.Category)

// イヤホン(ヘッドセット)の接続が切れたときに再生を続けるか(isKeep)、続けるならミュートにするか(isMute)。引数は2つとも必須で、1引数の形はない。切断は ACTION_AUDIO_BECOMING_NOISY で検知するため権限は不要(Android 12 以上の実機は要確認) · ミッション11
ShopLive.setKeepPlayVideoOnHeadphoneUnplugged(isKeep: Boolean, isMute: Boolean)

// 通話終了後に映像を自動再生するかどうか。READ_PHONE_STATE権限が必要 · ミッション11
ShopLive.setAutoResumeVideoOnCallEnded(isAutoResume: Boolean)

// プレーヤー開始時にミュートするかどうか · デフォルト値 false(サウンドオン) · ミッション11
ShopLive.setMuteWhenPlayStart(isMuted: Boolean)

// オーディオフォーカスを他のアプリに奪われたとき(電話など)にイベントを直接受け取って処理。OnAudioFocusListener は onGain() · onLoss() の2メソッド
ShopLive.setSoundFocusHandling(listener: OnAudioFocusListener?)

// 他アプリのオーディオと一緒に再生するか、外部オーディオ再生時に一時停止するか · デフォルト値 true(一緒に再生)
ShopLive.setMixWithOthers(isMixAudio: Boolean)

// プレーヤー開始時にミュートするかどうか · ミッション11
ShopLivePlayer().setMuteWhenPlayStart(isMute: bool)

// 他アプリのオーディオと一緒に再生するか、外部オーディオ再生時に一時停止するか
ShopLivePlayer().setMixWithOthers(isMixAudio: bool)

// サーバーに定義済みのcommand・payloadを送信(例: プレーヤー上にトーストを表示)
// トーストは command "SHOW_LAYER_TOAST"、payload のキーは message(必須) · duration(ms) · position(TOP/BOTTOM/CENTER) — 以前のドキュメントが根拠 · 要確認
sendCommandMessage(command: String, payload: [String:Any]?)

// ローカルストレージ保存機能を使用するかどうか
setUsingLocalStorage(_ use: Bool)

// アプリバージョンを送信(呼び出さなくてもSDKが自動的に読み取ってサーバーに送信)
setAppVersion(_ appVersion: String)

// プレーヤー実行前にカスタムデータ(key-value)を追加・削除
addParameter(key: String, value: String) / removeParameter(key: String)

// UTMパラメータをデータインサイトに一緒に送信
setUtmSource(utmSource: String?) / setUtmMedium(utmMedium: String?) / setUtmCampaign(utmCampaign: String?) / setUtmContent(utmContent: String?)

// サーバーに定義済みのcommand・payloadを送信
// トーストは command "SHOW_LAYER_TOAST"、payload のキーは message(必須) · duration(ms) · position(TOP/BOTTOM/CENTER) — 以前のドキュメントが根拠 · 要確認
ShopLive.sendCommandMessage(command: String?, payload: Map<String, Any?>)

// アプリバージョンを送信(呼び出さなくてもSDKが自動的に読み取ってサーバーに送信)
ShopLive.setAppVersion(appVersion: String)

// UTMパラメータをデータインサイトに一緒に送信
ShopLive.setUtmSource / setUtmMedium / setUtmCampaign / setUtmContent(String?)

// プレーヤー実行前にカスタムデータ(key-value)を追加・削除
ShopLive.addParameter(key: String, value: String?) / removeParameter(key: String)

// Shoplive標準のWeb Landingページの代わりに指定したURLを使用(事前協議が必要)
ShopLive.setEndpoint(endpoint: String?)

// 指定したURLをWeb Landingページとして使用(事前協議が必要)
ShopLivePlayer().setEndpoint(endpoint: String?)

// プレーヤー実行前にカスタムデータ(key-value)を追加・削除
ShopLivePlayer().addParameter(key: String, value: String?) / removeParameter(key: String)

// サーバーに定義済みのcommand・payloadを送信
ShopLivePlayer().sendCommandMessage(command: String, payload: Map<String, dynamic>)

// UTMパラメータをデータインサイトに一緒に送信
ShopLiveCommon().setUtmSource / setUtmMedium / setUtmCampaign / setUtmContent(String?)

// 現在のプレーヤースタイルを取得 (fullScreen / pip / unknown)
style: ShopLive.PresentationStyle

// 現在のプレーヤーモードを取得 (play / preview / none)
playerMode: ShopLive.PlayerMode

// 現在再生中の配信の映像比を取得 (portrait / landscape / unknown)
orientationMode: ShopLive.VideoOrientation

// プレーヤーが表示中のUIWindowインスタンス
playerWindow: ShopliveWindow?

// プレーヤーが表示中のUIViewControllerインスタンス(Alertなどをpresentする際に使用)
viewController: ShopLiveViewController?

// 配信への入場に成功したかを確認。handleReceivedCommand で ON_SUCCESS_CAMPAIGN_JOIN が届いた後から true
isSuccessCampaignJoin() -> Bool

// 視聴中の配信を終了
ShopLive.close()

// ルートActivity終了時に配信も一緒に終了するかどうか。falseの場合、アプリ終了時に直接close()を呼ぶ必要あり · デフォルト値 true(一緒に終了)
ShopLive.setAutoCloseWhenAppDestroyed(isAutoClosed: Boolean)

// 現在の画面状態を取得 (None / InAppPIP / PIP / Full)
ShopLive.getStatus(): Status

// プレビューポップアップ表示中かどうか
ShopLive.isShowingPreviewPopup(): Boolean

// 配信への入場に成功したかを確認。プレイヤーが ON_SUCCESS_CAMPAIGN_JOIN コマンドを送った後から true
ShopLive.isSuccessCampaignJoin(): Boolean

// (任意)SDK キャッシュのサイズ取得 · 削除。どちらも @WorkerThread なのでバックグラウンドで呼び出す。SDK が最後の Activity の破棄時に自動で整理するため、通常は呼ぶ必要はない
ShopLiveCommon.getCacheDirectoryBytes(context: Context): Long
ShopLiveCommon.deleteCacheFiles(ShopLiveCommon.getCacheDirectory(context)): Boolean

// 視聴中の配信を終了
ShopLivePlayer().close()

import ShopLiveSDK
import ShopliveSDKCommon   // リクエスト・レスポンスの型を直接使うときに必要

let request = ShopLiveCampaignListRequest(page: 1, size: 20, statuses: [.onair, .ready], order: .descending)

// コールバックはメインスレッドで正確に1回届く
let task = ShopLive.API.getCampaigns(request) { result in
    switch result {
    case .success(let response):
        for campaign in response.campaigns {
            if case .onair = campaign.lifecycle.status {
                print(campaign.campaignKey, campaign.title ?? "")
            }
            // showUserCount が false なら視聴者数を表示しない
            if let metrics = campaign.metrics, metrics.showUserCount {
                print(metrics.userCount ?? 0)
            }
        }
        print(response.hasMore)   // true なら page を1増やして再リクエスト
    case .failure(let error):
        print(error.codes)        // 9000 · サーバーコード · 9900 · 9901
    }
}
// 画面を離れるときに task.cancel() を呼ぶ

// iOS 13 以上の async 版。Task をキャンセルするとリクエストもキャンセルされ、CancellationError を投げる
let response = try await ShopLive.API.getCampaigns(ShopLiveCampaignListRequest(statuses: [.onair]))

val request = ShopLiveCampaignListRequest(
    page = 1,
    size = 20,
    statuses = listOf(ShopLiveCampaignFilterStatus.ONAIR, ShopLiveCampaignFilterStatus.READY),
    order = ShopLiveCampaignOrder.DESCENDING,
)

// コールバックはメインスレッドで正確に1回届く
val handle = ShopLiveCampaigns.getCampaigns(request, object : ShopLiveCampaignListListener {
    override fun onData(response: ShopLiveCampaignListResponse) {
        response.campaigns.forEach { campaign ->
            if (campaign.lifecycle.status == ShopLiveCampaignStatus.OnAir) {
                Log.d("Shoplive", campaign.campaignKey)
            }
            // showUserCount が false なら視聴者数を表示しない
            val metrics = campaign.metrics
            if (metrics != null && metrics.showUserCount) {
                Log.d("Shoplive", "${metrics.userCount}")
            }
        }
        // hasMore が true なら page を1増やして再リクエスト
    }

    override fun onError(error: ShopLiveCommonError) {
        Log.e("Shoplive", "${error.code}")   // 9000 · サーバーコード · 9900 · 9901 · 10000
    }
})
// 画面を離れるときに handle.cancel() を呼ぶ。キャンセルするとコールバックは一切届かない

// campaignKeyで配信映像の再生を開始。ShopLivePlayerDataのkeepWindowStateOnPlayExecuted(デフォルトtrue、実行モードを維持)・referrer・campaignHandler・brandHandler・isEnabledVolumeKeyで詳細動作を調整 · ミッション1
play(data: ShopLivePlayerData)

// campaignKeyでプレビューを再生。campaignKey・referrer・campaignHandler・brandHandler・isEnabledVolumeKeyは常に適用されますが、isMuted・resolution(.LIVE/.PREVIEW、デフォルト.PREVIEW)はdata引数が実際にShopLivePreviewData型のときだけ適用されます(ShopLivePlayerDataをそのまま渡すと無視される)。keepWindowStateOnPlayExecutedはこの経路では読み取られません(play専用) · ミッション9
preview(data: ShopLivePlayerData, completion: (() -> Void)?)

// 視聴中の配信を終了
close()

// Android SDK使用のためのAccessKeyを設定 · ミッション1
ShopLive.setAccessKey(accessKey: String)

// campaignKeyで配信映像を再生。keepWindowStateOnPlayExecuted(デフォルトtrue)・referrerで詳細動作を調整。intentPlayはIntentオブジェクトの生成のみを行い返す(自分でstartActivityしたい場合) · ミッション1
ShopLive.play(context: Context, data: ShopLivePlayerData) / ShopLive.intentPlay(...): Intent

// campaignKeyでポップアップ形式のプレビューを表示。ShopLivePreviewDataでサイズ・マージン・ミュート・閉じるボタン・スワイプ終了などを詳細に調整 · ミッション9
ShopLive.showPreviewPopup(activity: Activity, data: ShopLivePreviewData)

// ShopLivePreviewData.useCustomAction使用時、プレビューをタップした際の画面遷移にtransitionAnimationを適用
ShopLive.setPreviewTransitionAnimation(activity: Activity, view: View?)

// 再生中のポップアップ形式プレビューを非表示
ShopLive.hidePreviewPopup()

// campaignKeyで配信映像の再生を開始 · ミッション1
ShopLivePlayer().play(data: ShopLivePlayerData)

// campaignKeyでプレビューを表示 · ミッション9
ShopLivePlayer().showPreview(campaignKey: String)

// プレビュー表示オプションを指定 · ミッション9
ShopLivePlayer().setPreviewOption(data: ShopLivePlayerPreviewData)

// 表示中のプレビューを非表示
ShopLivePlayer().hidePreview()

// 現在再生中の映像をミュート
mute()

// 現在再生中の映像のミュートを解除
unmute()

// プレーヤーをミュート
ShopLive.mute()

// プレーヤーのミュートを解除
ShopLive.unmute()

// ShopLivePlayerPreviewの状態を初期化(campaignKey、campaignId、resizeMode、useCloseButtonなど) · ミッション9
preview.action(.initialize)

// accessKey・campaignKey を注入してプレイヤーを読み込む。グローバルの accessKey をこの値に置き換える · ミッション9
preview.action(.start(accessKey:campaignKey:referrer:))

// ミュート状態を設定 · ミッション9
preview.action(.setMuted(Bool))

// 追跡用識別子を注入 · ミッション9
preview.action(.setReferrer(String?))

// 再生 / 停止 / 停止+初期化 · ミッション9
preview.action(.play) / .pause / .stop

// 親ビューから削除しメモリ解放を開始 · ミッション9
preview.action(.close)

// 配信を再実行 · ミッション9
preview.action(.retry)

// 角の丸みを設定 · ミッション9
preview.action(.setCornerRadius(CGFloat))

// 閉じるボタンを使うか。1.9.0 では動作しない(閉じるボタン未対応)
preview.action(.useCloseButton(Bool))

// デバイスの音量ボタンでミュート解除を許可するかどうか · ミッション9
preview.action(.setEnabledVolumeKey(isEnabledVolumeKey: Bool))

// 映像の縦横比の維持方式 · デフォルト値 CENTER_CROP · ミッション9
preview.action(.setResizeMode(ShopLiveResizeMode))

// プレビュー解像度(.LIVE/.PREVIEW) · デフォルト値 .PREVIEW · ミッション9
preview.action(.setResolutionType(ShopLivePlayerPreviewResolution))

// イベントを購読するクロージャ (Result) -> ()。ケース: log · handleReceivedCommand · avPlayerTimeControlStatus · avPlayerItemStatus · requestShowAlertController · didChangeCampaignStatus · onError · handleCommand · onSetUserName · handleShare · didChangeCampaignInfo · didChangeVideoDimension · handleShopLivePlayerCampaign · handleShopLivePlayerBrand · ミッション9
preview.resultHandler

// 再生状態イベント(ready · playing · paused · buffering · failed)を受け取るデリゲート(ShopLivePlayerPreviewDelegate、weak)
preview.delegate

// 再生中かどうか / ミュートかどうか / AVPlayerItem の状態 / campaignKey・再生状態・ミュート・再生時間・キャンペーン・ブランド情報の取得
preview.isPlaying() / preview.isMuted() / preview.getPlayerItemStatus() / preview.getPlaybackInfo()

// レイアウトXMLに直接配置するプレビューコンポーネント · ミッション9
<cloud.shoplive.sdk.ShopLivePreview>

// 配信key・referrerを事前設定 · ミッション9
setCampaignKey(campaignKey: String?) / setReferrer(referrer: String?)

// プレビュープレーヤーの初期設定 · ミッション9
initializePlayer()

// プレビュー再生を開始(内部的にinitializePlayer→prepare→playの順で実行) · ミッション9
start() / start(accessKey:campaignKey:referrer:)

// プレビュー映像の準備 / 再生 / 一時停止 / 停止 · ミッション9
prepare() / play() / pause() / stop()

// プレビューリソースを解放 · ミッション9
release()

// プレビューを再実行 · ミッション9
retry()

// ミュート状態を切り替え · ミッション9
setMuted(isMuted: Boolean)

// 映像の縦横比の維持方式 · デフォルト値 CENTER_CROP · ミッション9
setResizeMode(resizeMode: ShopLiveResizeMode)

// LifecycleOwner登録時にライフサイクルに合わせて自動play/pause · ミッション9
setLifecycleObserver(owner: LifecycleOwner)

// プレビュー開始・初回フレーム描画・クリック・終了・画面比変更・再生状態変更のイベントリスナーを登録
setOnInitializeListener / setOnRenderedFirstFrameListener / setOnClickListener / setOnCloseListener / setOnDimensionRatioListener / setOnPlaybackStateChanged

// 閉じるボタンを使用するかどうか · ミッション9
useCloseButton(use: Boolean)

// デバイスの音量ボタンでミュート解除を許可するかどうか · ミッション9
setEnabledVolumeKey(isEnabledVolumeKey: Boolean)

// プレビュー解像度(LIVE/PREVIEW) · デフォルト値 PREVIEW · ミッション9
setResolutionType(resolutionType: ShopLivePreviewResolutionType)

// プレビュー終了後に画像を表示するかどうか · デフォルト値 true
setPostCampaignImageVisible(isPostCampaignImageVisible: Boolean)

// プレビューのメモリを解放 · ミッション9
destroy()

// campaignKey・再生状態・ミュート・再生時間・キャンペーン・ブランド情報を一度に取得
getPlaybackInfo(): ShopLivePreviewPlaybackInfo