API: Option

setShareScheme

[共有]を選択(タップ)すると、システム共有ポップアップへの転送する schemeが設定されます。 shareDelegateでは、iOSシステム共有ポップアップの代わりにカスタム共有ポップアップを直接実装できます。

setShareScheme(_ scheme: String?, shareDelegate: ShopLivePlayerShareDelegate?)

サンプルコード

let scheme = "shoplive://live"
let scheme = "https://shoplive.cloud/live"

class ViewController : UIViewController {
  
  func viewDidLoad(){ 
    // iOSシステム共有ポップアップ
		ShopLive.setShareScheme(scheme, shareDelegate: nil)
  }
} 
extension ViewController : ShopLiveShareDelegate { 
  func handleShare(data : ShopLivePlayerShareData) {
    //show share sheet
  }
}

ShopLivePlayerShareData



ShopLivePlayerShareCampaign

setChatViewFont

チャットフォントを設定し、チャットボタンのフォントを送信します。

setChatViewFont(inputBoxFont: UIFont, sendButtonFont: UIFont)

サンプルコード

/**
    // チャットフォントの設定
    let inputDefaultFont = UIFont.systemFont(ofSize: 14, weight: .regular)

    // チャット送信ボタンのフォント設定
    let sendButtonDefaultFont = UIFont.systemFont(ofSize: 14, weight: .medium)

*/

let customFont = UIFont(name: "{Custom Font}", size: 16)

// チャットフォントとチャット送信ボタンのフォント変更 
ShopLive.setChatViewFont(inputBoxFont: customFont, sendButtonFont: customFont)

setLoadingAnimation

ビデオの読み込みの進行状況を [画像アニメーション] に設定します。

setLoadingAnimation(images: [UIImage])

サンプルコード

var images: [UIImage] = []

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

ShopLive.setLoadingAnimation(images: images)

setInAppPipConfiguration

InAppPip 関連のオプションを設定します。 setInAppPipConfiguration(config:) に設定された値は、以前に非推奨になった API によって設定された値よりも優先されます。

setInAppPipConfiguration(config: ShopLiveInAppPipConfiguration?)

• pipMaxSize は .scaleAspectFill に設定されています。 たとえば、pipMaxSizeは100です 横向きモードでは、100 x 100 x (アスペクト比) ポートレートモードでは、縦100、横100x(アスペクト比)になります。

📘Objective-C 環境では、ShopLiveInAppPipConfigurationObjc オブジェクトを使用します。

サンプルコード

//maxSize
let pipSize = ShopLiveInAppPipSize(pipMaxSize : 200)
//fixedHeight
let pipSize = ShopLiveInAppPipSize(pipFixedHeight : 200)
//fixedWidth
let pipSize = ShopLiveInAppPipSize(pipFixedWidth  :200)

let inAppPipConfig = ShopLiveInAppPipConfiguration(pipSize: pipSize,
                                                   useCloseButton: true,
                                                   pipPosition: .bottomLeft,
                                                   enableSwipeOut: true,
                                                   pipRadius : 10)
ShopLive.setInAppPipConfiguration(config: inAppPipConfig)

getPreviewSize

プレビューのサイズを取得します。

getPreviewSize(inAppPipConfiguration: ShopLiveInAppPipConfiguration, videoRatio: CGSize) -> CGSize

addSubViewToPreview

Shoplive preview上にお客様のcustomViewを表示します。

注意

customView を表示する場合は、ShopLiveInAppPipConfiguration(useCloseButton: false) を使用します。

addSubViewToPreview(subView: UIView)

サンプルコード

func setCustomerPreviewCoverView() {
    var previewViewCoverView = UIView()
    previewViewCoverView.addSubview(someView1)
    previewViewCoverView.addSubview(someView2)
    NSLayoutConstraint.activate([
        someView1.topAnchor.constraint(equalTo: previewViewCoverView.topAnchor),
        someView1.trailingAnchor.constraint(equalTo: previewViewCoverView.trailingAnchor),
        someView1.widthAnchor.constraint(equalToConstant: 70),
        someView1.heightAnchor.constraint(equalToConstant: 30),
            
        someView2.bottomAnchor.constraint(equalTo: previewViewCoverView.bottomAnchor),
        someView2.leadingAnchor.constraint(equalTo: previewViewCoverView.leadingAnchor),
        someView2.trailingAnchor.constraint(equalTo: previewViewCoverView.trailingAnchor),
        someView2.heightAnchor.constraint(equalToConstant: 40)
    ])
    ShopLive.addSubViewToPreview(subView: previewViewCoverView)
}

startPictureInPicture

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

startPictureInPicture(with position: ShopLive.PipPosition, scale: CGFloat)
startPictureInPicture()

サンプルコード

// 0.4倍(デフォルト)サイズでアプリ内PIPモードに切り替えます。
ShopLive.startPictureInPicture()

// 画面右下から0.1倍サイズでアプリ内PIPを切り替えます。
ShopLive.startPictureInPicture(with: .bottomRight, scale: 0.1)

// 画面左上から0.8倍サイズでアプリ内PIPを切り替えます。
ShopLive.startPictureInPicture(with: .topLeft, scale: 0.8)

サイズ設定の例

• アプリケーションガイド: APIを使用してアプリ内のピクチャーインピクチャー状態を切り替える

stopPictureInPicture

ピクチャーインピクチャーモードをフルスクリーンモードに切り替えます。

stopPictureInPicture()

サンプルコード

ShopLive.stopPictureInPicture()

hookNavigation

商品またはバナーを選択すると、パラメーターに設定した custom  Callback 関数 (パラメーターとして入力した navigation)を使用してイベントを直接受信します。

hookNavigation(navigation: @escaping ((URL) -> Void))

サンプルコード

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

• アプリケーションガイド: API 関数を使用してイベントをディスパッチする

KeepWindowStyleOnReturnFromOsPip

setKeepWindowStyleOnReturnFromOsPip

OS PIPを使用している場合、Shoplive Playerの再生中(PIP、フルスクリーン)に動画がOS PIPに入り、ホーム画面または別のアプリに移動します(バックグラウンド状態に切り替わります)。 アプリに戻ったときに、最後に再生していた状態(PIP、フルスクリーン)に切り替えるか、常に全画面表示にするかを選択できます。

setKeepWindowStyleOnReturnFromOsPip(_ keep: Bool)

サンプルコード

// OS PIPに切り替わる前の最後の再生中の状態を維持するように設定します。
ShopLive.setKeepWindowStyleOnReturnFromOsPip(true)

// OS PIP状態からアプリに切り替わり、常に全画面表示に切り替わるように設定する
ShopLive.setKeepWindowStyleOnReturnFromOsPip(false)

isKeepWindowStyleOnReturnFromOsPip

現在設定されているマントを返します。

• true: 最後の再生状態(PIP、フルスクリーン)に切り替えます(デフォルト)

• false: 常に全画面表示に切り替えます

isKeepWindowStyleOnReturnFromOsPip() -> Bool

サンプルコード

print(ShopLive.isKeepWindowStyleOnReturnFromOsPip())

ShopLiveCommonUser

Shoplive を使用している認証済みユーザーです。 ユーザーを認証するためのユーザーの情報を入力します。

var user: ShopLiveCommonUser? { get set }

// ユーザーの性別
public enum ShopliveCommonUserGender : String, CaseIterable {
    case female = "f"
    case male = "m"
    case neutral = "n"
}

public class ShopLiveCommonUser: NSObject {
    var userId: String?
    var name: String?
    var age: Int?
    var gender: ShopliveCommonUserGender?
    var userScore : Int?
    var custom : [String : Any]?
}

• アプリケーションガイド: 単純な認証済みユーザーとしてチャットする

📘Objective-C 環境では、ShopLiveCommonUserObjc オブジェクトを使用してください。

authToken

Shoplive 文字列を使用した認証済みユーザーのセキュリティ認証トークン (JWT)。 認証されたユーザーのセキュリティ認証トークン (JWT) 文字列を入力して、ユーザーを認証します。

var authToken: String? { get set }

サンプルコード

let generatedJWT = "eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MTA1NzA1dfadsfasfadsfasdfwO"

ShopLive.authToken = generatedJWT

style

これは現在のShoplivePlayerスタイルです。

var style: ShopLive.PresentationStyle { get }

public enum PresentationStyle: Int {
    case unknown
    case fullScreen
    case pip
}

サンプルコード

print(ShopLive.style)

playerMode

これは、現在のShoplivePlayerのmodeです。

var playerMode: ShopLive.PlayerMode { get }

public enum PlayerMode: Int {
    case play
    case preview
    case none
}

enum PlayerMode

orientationMode

これは、Shoplive Platyerで現在再生されているライブ放送の動画の割合情報です。

var orientationMode: ShopLive.VideoOrientation { get }

public enum VideoOrientation: Int {
    case portrait
    case landscape
    case unknown
}

enum VideoOrientation

playerWindow

Shoplive Player が現在表示されている UIWindow のインスタンス。

var playerWindow: ShopLiveWindow? { get }

playerWindow.forceAddSubView

この関数は、ShopLive フレームワークの上にクライアントのビューを配置する場合に使用します。

一般的なaddSubViewの場合、ShopLiveのポリシーにより、クライアントのビューが追加されない場合があります。

ShopLive.playerWindow?.forceAddSubView({YOUR_VIEW})

viewController

これは、Shoplive Player が現在表示されている UIViewController のインスタンスです。

var viewController: ShopLiveViewController? { get }

サンプルコード

// Shoplive Player上にAlertを表示
let alert = UIAlertController.init(title: "Alert on Player", message: nil, preferredStyle: .alert)
alert.addAction(UIAlertAction(title: "OK", style: .default, handler: nil))

ShopLive.viewController?.present(alert, animated: true, completion: nil)

setVisibleStatusBar options

Shoplive Playerが全画面表示で再生されているときに、アプリのステータスバーを非表示にすることができます。 inAppPipの場合、ステータスバーが自動的に表示されます。

setVisibleStatusBar

setVisibleStatusBar(isVisible : Bool)

サンプルコード

ShopLive.setVisibleStatusBar(isVisible : Bool)

indicatorColor

ローディングインジケーターの色を設定します。

var indicatorColor: UIColor { get set }

サンプルコード

ShopLive.indicatorColor = UIColor.red

isSuccessCampaignJoin

ブロードキャスト エントリが成功したかどうかを確認します。

• 関連 callback: handleReceivedCommand - ON_SUCCESS_CAMPAIGN_JOIN

isSuccessCampaignJoin() -> Bool

サンプルコード

print(ShopLive.isSuccessCampaignJoin())

AutoResumeVideoOnCallEnded options

通話が終了した後にビデオに戻ったら、自動再生に設定します。

setAutoResumeVideoOnCallEnded

setAutoResumeVideoOnCallEnded(_ autoResume: Bool)

サンプルコード

ShopLive.setAutoResumeVideoOnCallEnded(true)

isAutoResumeVideoOnCallEnded

現在設定されている値を返します。

• true: 通話終了後の自動再生

• false: 通話終了後にビデオが停止する

isAutoResumeVideoOnCallEnded() -> Bool

サンプルコード

print(ShopLive.isAutoResumeOnCallEnded())

KeepPlayVideoOnHeadphoneUnplugged options

イヤホン(またはヘッドセット)が切断されたら、ビデオを停止せずに自動再生するように設定します。

setKeepPlayVideoOnHeadphoneUnplugged

イヤホン(またはヘッドセット)が切断されたら、ビデオを停止せずに自動再生するように設定します。

setKeepPlayVideoOnHeadphoneUnplugged(_ keepPlay: Bool)

サンプルコード

ShopLive.setKeepPlayVideoOnHeadphoneUnplugged(true)

isKeepPlayVideoOnHeadPhoneUnplugged

現在設定されている値を返します。

• true: ビデオは再生を続けます

• false: 切断するとビデオが停止します

isKeepPlayVideoOnHeadPhoneUnplugged() -> Bool

サンプルコード

print(ShopLive.isKeepPlayVideoOnHeadPhoneUnplugged())

NextActionOnHandleNavigation options

ユーザーが商品、お知らせ、バナーなどのリンクを選択すると、Shoplive Playerに次のアクションが設定されます。

public enum ActionType: Int {
    case PIP
    case KEEP
    case CLOSE
}

enum ActionType

setNextActionOnHandleNavigation

setNextActionOnHandleNavigation(actionType: ActionType)

サンプルコード

// PIP切り替え
ShopLive.setNextActionOnHandleNavigation(.PIP)

// 状態を維持する
ShopLive.setNextActionOnHandleNavigation(.KEEP)

// 終了
ShopLive.setNextActionOnHandleNavigation(.CLOSE)

getNextActionTypeOnHandleNavigation

Shoplive Player では、ユーザーがリンクを選択したときに設定される次のアクションに注目してください。

getNextActionTypeOnHandleNavigation() -> ActionType

サンプルコード

print(ShopLive.getNextActionTypeOnHandleNavigation())

• アプリケーションガイド: ユーザーリンク選択時のShopLive Playerの次のアクションを設定する

sendCommandMessage

コマンドとペイロードをサーバーに配信します。コマンドとペイロードを事前定義された形式で渡すことができます。 (あるいは、Shoplive と相談してコマンドとペイロードを定義することもできます。)

@objc static func sendCommandMessage(command: String, payload: [String:Any]?)

Sample code

let command: String = “COMMAND_NAME”
var payload: [String : Any] = [:]

payload[“Int_Data” : 1]
payload[“String_Data” : “Sample_String”]

ShopLive.sendCommandMessage(command: command, payload: payload)

setMuteWhenPlayStart

Shoplive Player の起動時にサウンドをオンまたはミュートに設定します。 (デフォルト: サウンドがオンになった状態で Shoplive Player が起動します。)

@objc static func setMuteWhenPlayStart(_ mute: Bool)

Sample code

// Mute when player started
ShopLive.setMuteWhenPlayStart(true)

//Sound on when player started
ShopLive.setMuteWhenPlayStart(false)

setEnabledPictureInPicture

アプリが InAppPip と OSPip をサポートするかどうかを決定します (デフォルト : true )

@objc static func setEnablePictureInPicture(isEnabled: Bool)

Sample code

// Enable InAppPip and OSPIP
ShopLive.setEnabledPictureInPicture(isEnabled: true)

// Disable InAppPip and OSPIP
ShopLive.setEnabledPictureInPicture(isEnabled: false)

setEnableOSPictureInPicture

アプリが OS の PIP をサポートするかどうかを決定します (デフォルト : true)

@objc static func setEnabledOSPictureInPictureMode(isEnabled: Bool)

Sample code

// InAppPip(Enabled), OSPIP (Disabled)
ShopLive.setEnabledPictureInPicture(isEnabled: true)
ShopLive.setEnabledOSPictureInPicture(isEnabled: false)

// InAppPip, OSPIP both enabled
ShopLive.setEnabledPictureInPicture(isEnabled: true)
ShopLive.setEnabledOSPictureInPicture(isEnabled: true)

// InAppPip, OSPIP both disabled
ShopLive.setEnabledPictureInPicture(isEnabled: false)
ShopLive.setEnabledOSPictureInPicture(isEnabled: true)

setPictureInPicturePadding

アプリ内の PIP で PIP パディングを設定します。 （上、左、右、下）（デフォルト: 上、左、右、下はすべて 20 に設定）無効な値が設定されている場合は、false を返し、デフォルト値を適用します。

@objc static func setPictureInPicturePadding(padding: UIEdgeInsets) -> Bool

Sample code

// left: 20 right: 30 bottom: 10 top: 10

let padding: UIEdgeInsets = .init(top: 10, left: 20, bottom: 10, right: 30)

ShopLive.setPictureInPicturePadding(padding: padding)

• 関連ガイド: PIPが移動できないようデバイスにオフセットを割り当てます

setPictureInPictureFloatingOffset

アプリ内PIPで、PIPが移動できる領域を設定します。 無効な値が設定されている場合は、切り上げられ、 falseデフォルト値が受け入れられます。

@objc static func setPictureInPictureFloatingOffset(offset: UIEdgeInsets) -> Bool

サンプルコード

// left: 20, right: 30, bottom: 10, top: 10でオフセット値を設定します。

let offset: UIEdgeInsets = .init(top: 10, left: 20, bottom: 10, right: 30)

ShopLive.setPictureInPictureFloatingOffset(offset: offset)

setUsingLocalStorage

ローカルストレージの保存機能を使用するかどうかを設定します。

@objc static func setUsingLocalStorage(_ use: Bool)

サンプルコード

// ローカルストレージの保存機能を使用するように設定
ShopLive.setUsingLocalStorage(true)

// ローカルストレージの保存機能を使用しないように設定
ShopLive.setUsingLocalStorage(false)

setAppVersion

アプリのバージョンを設定します。

• API を呼び出さなくても、既定でアプリのバージョンが読み取られ、サーバーに渡されます。

• この機能を使用する場合は、Shoplive の担当者にお問い合わせください (ask@shoplive.cloud)。

@objc static func setAppVersion(_ appVersion: String)

サンプルコード

let appVersion: String = “1.0.0”

ShopLive.setAppVersion(appVersion)

setMixWithOthers

外部音声で放送を視聴できます。

@objc static func setMixWithOthers(_ isMixAudio: Bool)

サンプルコード

// 外部オーディオが再生されるとPlayerは一時停止します。
ShopLive.setMixWithOthers(false)

// 外部オーディオと一緒に放送を視聴する
ShopLive.setMixWithOthers(true)

useCloseButton

閉じるボタンは、プレビューモードとピクチャーインピクチャーモードでアクティブにできます。

@objc static func useCloseButton(_ use: Bool)

サンプルコード

// PreviewとPIPモードで閉じるボタンは使用しない。
ShopLive.useCloseButton(false)

// PreviewとPIPモードで閉じるボタンを使用します。
ShopLive.useCloseButton(true)

addParameter

プレーヤーを起動する前に、カスタムデータを追加できます。

@objc static func addParameter(key: String, value: String)

サンプルコード

ShopLive.addParameter(key: "key", value: "value")

removeParameter

プレーヤーを起動する前に、addParameterで追加したカスタムデータを削除します。

@objc static func removeParameter(key: String)

サンプルコード

ShopLive.removeParameter(key: "key)

setUtmSource

UTM Sourceを追跡できます。データは データインサイトにあります。

func setUtmSource(utmSource: String?)

サンプルコード

ShopLive.setUtmSource(“{utm_source}”)

setUtmMedium

UTM Mediumを追跡できます。データは データインサイトにあります。

func setUtmMedium(utmMedium: String?)

サンプルコード

ShopLive.setUtmMedium(“{utm_medium}”)

setUtmCampaign

UTM Campaignを追跡できます。データは データインサイトにあります。

func setUtmCampaign(utmCampaign: String?)\

サンプルコード

ShopLive.setUtmCampaign(“{utm_campaign}”)

setUtmContent

UTM Contentを追跡できます。データは データインサイトにあります。

func setUtmContent(utmContent: String?)

サンプルコード

ShopLive.setUtmContent(“{utm_content}”)

setResizeMode

ビデオのアスペクト比を維持できます。 (デフォルト: .CENTER_CROP)

ShopLive.setResizeMode(option : ShopLiveResizeMode)