プレイヤーへのコマンド送信

    プレイヤーへのコマンド送信


    記事の要約

    プレイヤーにコマンドを送信する際に使用します。これにより、プレーヤー内の特定のUIコンポーネントを表示または非表示にしたり、オーディオをミュートまたはミュート解除したりすることもできます。

    const player = cloud.shoplive.getPlayer();
    player.sendMessage(action,payload);

    メッセージの送信

    アクション

    機能

    ペイロード

    showControls

    コントロール UI の表示

    N/A

    mute

    音声をミュートする

    N/A

    unmute

    音声のミュートを解除する

    N/A

    removeBanner

    バナーを削除

    N/A

    removeCoupon

    クーポンを削除

    N/A

    removeNotice

    通知を削除

    N/A

    showToast

    トースト通知を表示

    {
    "message": "{message}",
    "duration": {ミリ秒},
    "position": "BOTTOM|CENTER|TOP"
    }

    SEND_COMMAND_MESSAGE

    コマンド・メッセージの送信

    {
    command: "SET_BRAND_FAVORITE",
    payload: { identifier: identifier, favorite: true  }
    }

    SEND_COMMAND_MESSAGE

    SEND_COMMAND_MESSAGEは、SET_BRAND_FAVORITEなどの特別なコマンドを送信するためのコマンドです。

    • command: SET_BRAND_FAVORITE

      • ペイロード

        名前

        種類

        説明: __________

        お気に入り

        ブーリアン

        真 |偽

        ブランドのお気に入りかどうか

        識別子

        ショップライブ

        ブランド識別名

    サンプルコード

    クーポンをクリックすると、アラートウィンドウが表示され、クーポンが削除されます

    
    // Downloaded coupon and send tracking event manually
    var messageCallback = {
      DOWNLOAD_COUPON: function(payload, parent) {
        const player = cloud.shoplive.getPlayer();
        var type = payload.type;
        var coupon = payload.coupon;
        alert(payload.coupon + " Coupon download complete.");
        if (type === "BANNER") {
          player.sendMessage("removeBanner"); 
        } else if (type === "COUPON") {
          player.sendMessage("removeCoupon"); 
        } else if (type === "NOTICE") {
          player.sendMessage("removeNotice"); 
        }
      },
    };