目次 x
    Live API
      • 印刷する
      目次

      Live API

        • 印刷する
        記事の要約

        Installing Live

        https://pub.dev/packages/shoplive_player/install

        Depend on it

        Run this command:

        With Flutter:

         $ flutter pub add shoplive_player

        This will add a line like this to your package's pubspec.yaml (and run an implicit flutter pub get):

        dependencies:
  shoplive_player: ^1.6.5

        Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

        Import it

        Now in your Dart code, you can use:

        import 'package:shoplive_player/shoplive_player.dart';

        ライブ配信開始

        void play({required ShopLivePlayerData data})をクリックして、ライブ詳細画面を再生します。

        ショップライブプレイヤーデータ

        プロパティ名

        種類

        形容

        キャンペーンキー

        糸

        再生する動画のキャンペーン(放送)キー(必須)

        keepWindowStateOnPlayExecuted

        ブーリアン

        再生中のプレーヤーの実行モード(pip、全画面表示)を維持しながら再生を開始するかどうか。デフォルト (false)

        • true: プレイ中のプレイヤーの実行モードを維持します。

        • false: 全画面表示で実行されます。

        リファラー

        糸。

        エントリーパスの統計を測定できるパラメータ

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.play(data: data);

        ライブの終了

        void close()をクリックして、ライブ詳細画面を終了します。

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.close();

        ライブプレビューを実行する

        void showPreview({required ShopLivePlayerPreviewData data})をクリックして、ライブプレビューを実行します。

        ショップライブプレイヤープレビューデータ

        プロパティ名

        種類

        形容

        キャンペーンキー

        糸

        再生する動画のキャンペーン(放送)キー(必須)

        useCloseButton

        ブーリアン

        「閉じる」ボタンをアクティブにします。デフォルト (false)

        リファラー

        糸。

        エントリーパスの統計を測定できるパラメータ

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.showPreview(data: data);

        シェア 住所を設定する

        void setShareScheme({required String shareSchemeUrl}) 共有アドレスは、

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.setShareScheme(shareSchemeUrl: "https://shoplive.cloud/");

        PIP の切り替え

        void startPictureInPicture() フルスクリーンモードからピクチャーインピクチャーモードに切り替えます。

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.startPictureInPicture();

        全画面表示に切り替える

        void stopPictureInPicture() ピクチャーインピクチャーモードからフルスクリーンモードまで。

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.stopPictureInPicture();

        ミュートを開始する

        void setMuteWhenPlayStart({required bool isMute})からミュートを開始できます。

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.setMuteWhenPlayStart(isMute: false);

        商品・バナー情報配信機能

        Stream<ShopLiveHandleNavigation> handleNavigationLiveで商品やバナーなどを選択すると、選択した商品やバナーの情報が配信されます。

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.handleNavigation.listen((data) {
  _showToast("handleNavigation : ${data.url}");
});

        クーポン情報配信機能

        Stream<ShopLiveHandleDownloadCoupon> handleDownloadCouponLiveでクーポンを選択すると、選択したクーポン情報が配信されます。

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.handleDownloadCoupon.listen((data) {
  _showToast("handleDownloadCoupon : ${data.couponId}");
});

        ブロードキャストステータス転送機能

        Stream<ShopLiveChangeCampaignStatus> changeCampaignStatusライブ放送でブロードキャストの状態が変更されたときに通信します。

        ショップライブチェンジキャンペーンステータス

        パラメータ名

        種類

        形容

        キャンペーンステータス

        糸

        キャンペーンステータス: READY、 ONAIR、 CLOSED

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.changeCampaignStatus.listen((data) {
  _showToast("changeCampaignStatus : ${data.campaignStatus}");
});

        キャンペーン情報配信機能

        Stream<ShopLiveCampaignInfo> campaignInfoキャンペーン情報はライブでご確認いただけます。

        ショップライブキャンペーン情報

        パラメータ名

        種類

        形容

        キャンペーン情報

        JSONオブジェクト

        キャンペーン情報

        例えば： {'title':'방송 제목'}

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.campaignInfo.listen((data) {
  _showToast(
      "campaignInfo : ${const JsonEncoder().convert(data.campaignInfo)}");
});

        ポップアップカスタム機能

        Stream<ShopLiveHandleCustomAction> handleCustomAction ポップアップで選択イベントcustomを指定し、ポップアップが選択されたときにポップアップ情報を渡します。ポップアップのid、type、payloadを渡す。

        ショップライブハンドルカスタムアクション

        パラメータ名

        種類

        形容

        身分証明書

        糸

        クーポンまたはバナーID

        種類

        糸

        クーポンまたはバナータイプ

        ペイロード

        糸

        ユーザー定義のペイロード

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.handleCustomAction.listen((data) {
  _showToast(
      "handleCustomAction : ${data.id}, ${data.type}, ${data.payload}");
});

        プレイヤーステータス情報配信機能

        Stream<ShopLiveChangedPlayerStatus> changedPlayerStatus ライブプレイヤーのステータスを受け取ります。

        ショップライブチェンジプレイヤーステータス

        パラメータ名

        種類

        形容

        地位

        ショップライブプレイステータス

        プレイヤーのステータス(作成済み、破壊済み)

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.changedPlayerStatus.listen((data) {
  _showToast("changedPlayerStatus: ${data.status}");
});

        メッセージコールバック検証機能

        Stream<ShopLiveReceivedCommand> receivedCommand 受信したメッセージの内容を確認できます。

        ショップライブ受信コマンド

        プロパティ名

        種類

        形容

        命令

        糸

        コマンドの名前

        データ

        マップ<文字列、動的>?

        追加の関連パラメータ

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.receivedCommand.listen((data) {
  _showToast(
      "receivedCommand : ${data.command}, ${const JsonEncoder().convert(data.data)}");
});

        ログ機能

        Stream<ShopLivePlayerLog> log ライブログを受信します。

        ショップライブプレイヤーログ

        プロパティ名

        種類

        形容

        名前

        糸

        イベントの名前。

        特徴

        糸

        clickの種類 イベントの、show、 action

        キャンペーンキー

        糸。

        放送のユニークなキー

        パラメーター

        マップ<文字列、動的>?

        追加の関連パラメータ

        late final _shopLivePlayerPlugin = ShopLivePlayer();
_shopLivePlayerPlugin.log.listen((data) {
  _showToast(
      "clickLog : ${data.name}, ${data.feature}, ${data.campaignKey}, ${const JsonEncoder().convert(data.payload)}");
});

        What's Next