API - Play
configure(with:)
Shoplive 담당자에게 받은 액세스 키(Access Key)를 사용하여 Shoplive iOS SDK를 초기화합니다.
configure(with accessKey: String)
| 매개변수 | 설명 |
|---|---|
| AccessKey | Shoplive 담당자에게 받은 액세스 키(Access Key) |
샘플 코드
ShopLive.configure(with: "{AccessKey}")
- 적용 가이드
play(data : ShopLivePlayerData)
ShopLivePlayerData를 사용하여 영상을 재생합니다.
play(data : ShopLivePlayerData)
ShopLivePlayerData
| 매개변수 | 설명 |
|---|---|
| campaignKey | 재생할 영상의 캠페인(방송) 키(required) |
| keepWindowStateOnPlayExecuted | 재생중인 플레이어의 실행 모드(Pip, Fullscreen)을 유지한 상태로 재생을 시작할 지 여부. 기본값(true) true: 재생중인 플레이어의 실행 모드를 유지합니다. false: fullscreen으로 실행됩니다. |
| referrer | 진입경로 통계를 측정할 수 있는 파라미터 (optional) |
| campaignHandler | ((ShopLivePlayerCampaign) -> ())? Shoplive의 방송 캠페인에 대한 정보를 받을 수 있는 handler입니다. |
| brandHandler | ((ShopLivePlayerBrand) -> ())? Shoplive의 방송 브랜드에 대한 정보를 받을 수 있는 handler입니다. |
Objective-C 환경에서는 ShopLivePlayerDataObjc 객체를 사용해 주시기 바랍니다.
ShopLivePlayerCampaign
| 매개변수 | 설명 |
|---|---|
| title | 캠페인 제목 |
| campaignStatus | 캠페인의 상태(READY, ONAIR, CLOSED) |
ShopLivePlayerBrand
| 매개변수 | 설명 |
|---|---|
| name | 브랜드의 이름 |
| identifier | 브랜드의 고유 식별자 |
| imageUrl | 브랜드의 thumbnail 이미지 주소 |
샘플 코드
ShopLive.play(data:.init(campaignKey: "{CampaignKey}", keepWindowStateOnPlayExecuted: true, referrer: "{진입경로}", campaignHandler : ((ShopLivePlayerCampaign) -> ())? = nil, brandHandler : ((ShopLivePlayerBrand) -> ())? = nil))
- 적용 가이드
preview(data : ShopLivePlayerData,completion:)
ShopLivePlayerData를 사용하여 preview를 재생합니다.
preview(data : ShopLivePlayerData,completion: (() -> Void)?)
ShopLivePlayerData
| 매개변수 | 설명 |
|---|---|
| campaignKey | 재생할 영상의 캠페인(방송) 키(required) |
| keepWindowStateOnPlayExecuted | 재생중인 플레이어의 실행 모드(Pip, Fullscreen)을 유지한 상태로 재생을 시작할 지 여부. 기본값(false) true: 재생중인 플레이어의 실행 모드를 유지합니다. false: Fullscreen으로 실행됩니다. |
| referrer | 진입경로 통계를 측정할 수 있는 파라미터 (optional) |
Objective-C 환경에서는 ShopLivePlayerDataObjc 객체를 사용해 주시기 바랍니다.
샘플 코드
ShopLive.preview(data:.init(campaignKey: "{CampaignKey}", keepWindowStateOnPlayExecuted: true, referrer: "{진입경로}"),completion : nil)
- 적용 가이드
close(actionType : ShopLiveViewHiddenActionType = .onClose)
시청 중인 방송을 종료합니다.
ShopLiveViewHiddenActionType
| case | 설명 |
|---|---|
| onSwipeOut | Preview를 쓸어넘겨서 종료 |
| onBtnTapped | 뒤로가기 버튼을 눌러서 종료 |
| onClose | close()함수를 호출해서 종 |
| onError | 오류로 인한 종 |
| onRestoringPip | Pip에서 앱으로 복귀시 에러로 종 |
| onNavigationHandleClose | 사용자가 nextActionTypeOnHandleNavigation의 정의 .CLOSE로 했을때 종료 |
*샘플 코드
ShopLive.close()
Updated about 1 month ago