shoplive_player library
Shoplive 플레이어(player) Flutter 플러그인 — Android cloud.shoplive:shoplive-player-sdk · iOS ShoplivePlayerSDK(버전은 README).
채널 계약: design.md rev2 §2.4·§2.5·§2.7 (DRAFT-flutter-sdk-302-android). shoplive_core API를 함께 export한다.
Classes
- Shoplive
- Shoplive core API(design.md rev2 §2.4 shoplive_core). 모든 메서드는 실패 시 PlatformException을 던진다.
- ShopliveAnalyticsEvent
- ShopliveAndroidPlayerOptions
- Android 전용 옵션(configuration.android, CS-03). iOS에서는 무시된다.
- ShopliveAppearanceOptions
- ShopliveAttribution
- ShopliveBrand
- ShopliveButtonOptions
-
in-App PIP 버튼 옵션(SDK 3.0.4+
ButtonOptions, SMV-1899). OS PIP 창에는 적용되지 않는다. - ShopliveCampaign
- ShopliveCampaignInfo
- 캠페인 정보(getCurrentCampaign / campaignInfoReceived). status는 nullable(SDK @Nullable, design §2.6).
- ShopliveCampaignInfoReceived
- ShopliveCampaignLifecycle
- 방송 진행 상태.
- ShopliveCampaignLifecycleClosed
- ShopliveCampaignLifecycleOnAir
- ShopliveCampaignLifecycleReady
- ShopliveCampaignLifecycleReserved
- ShopliveCampaignLifecycleStatus
- 서버 표기 상태. 이 플러그인 버전이 모르는 값은 ShopliveCampaignLifecycleUnknown이 원문을 담는다(양 OS 네이티브와 같은 모양).
- ShopliveCampaignLifecycleUnknown
- 모르는 서버 상태. value는 서버 원문(SDK가 원문을 주지 못하면 null).
- ShopliveCampaignListItem
- 목록의 방송 하나. 시각은 UTC DateTime이다(네이티브는 epoch ms).
- ShopliveCampaignListRequest
- 목록 조회 조건. 값을 주지 않은 조건은 SDK·서버 기본값을 쓴다.
- ShopliveCampaignListResponse
- 목록 조회 결과. hasMore가 true면 다음 page가 있다.
- ShopliveCampaignMetrics
- 시청 지표. showUserCount가 false면 userCount·adoreCount를 UI에 노출하지 않아야 한다.
- ShopliveCampaignStatusChanged
- ShopliveCancelToken
- ShoplivePlayerAPI.getCampaigns 취소 토큰. 하나를 여러 호출에 넘기면 cancel 한 번에 아직 끝나지 않은 호출이 모두 취소된다. 한 번 취소한 토큰은 되돌릴 수 없다 — 그 토큰으로 새 호출을 하면 바로 취소로 끝난다.
- ShopliveConfiguration
-
Shoplive.initialize설정(design.md rev2 §2.4·§2.6). null 필드는 키를 생략해 SDK 기본값을 쓴다. - ShopliveConnectionStateChanged
- ShopliveConversionData
-
Shoplive.sendConversionEvent데이터(design.md rev2 §2.4·§2.6). null 필드는 키를 생략한다. - ShopliveConversionProduct
- ShopliveCorePlatform
- shoplive_core 플랫폼 인터페이스. 인자는 이미 wire Map으로 변환된 값이다.
- ShopliveCouponRequest
- 쿠폰 받기 요청. respond는 1회만 유효하다(C-4).
- ShopliveCouponResult
- 쿠폰·커스텀 액션 응답(design §2.4 respondCoupon/respondCustomAction). status는 계약상 필수.
- ShopliveCustomActionResult
- ShopliveCustomWebActionRequest
- 커스텀 버튼 요청. respond는 1회만 유효하며 false 사유는 ShopliveCouponRequest와 같다(C-4).
- ShopliveError
-
SDK Error 이벤트 payload(design.md rev2 §2.5
error). - ShopliveGuestUser
- ShopliveInsets
- PIP 여백(px). null 변은 현재 값 유지.
- 상품·링크 이동 요청. 응답 없음.
- ShopliveOverlayOptions
- ShoplivePipOptions
- ShoplivePlatformErrorCode
-
채널 계약의
PlatformException.code값(design.md rev2 §2.2). Dart API는 PlatformException을 그대로 전파한다. - ShoplivePlaybackEvent
- ShoplivePlayer
- ShoplivePlayerAPI
-
Shoplive 서버 조회 API — 네이티브 Android·iOS
ShoplivePlayerAPI와 같은 이름(SMV-1899 D10). 세션과 무관하다.Shoplive.initialize로 accessKey를 정한 뒤 부른다. - ShoplivePlayerConfiguration
-
플레이어 설정(design.md rev2 §2.4 Configuration). 모든 필드가 선택이며 현재 설정 위에 병합된다(CFG-01):
null 필드는 현재 값을 유지한다.
getConfiguration()은 전체 값을 채워 돌려준다. - ShoplivePlayerContract
- 채널·메서드 이름(계약 단일 출처 — Kotlin PlayerContract와 같은 목록).
- ShoplivePlayerErrorEvent
-
SDK 오류. ShopliveError.code는 불투명 문자열로 다룬다(새 코드가 추가될 수 있음).
예: Android에서 앱 PIP 권한이 꺼진 기기의 풀스크린 PIP 요청은
PIP_DISABLED_BY_USER(rawCode 9511)로 오고 화면은 바뀌지 않는다(SDK 3.0.6). - ShoplivePlayerEvent
-
shoplive_player/events이벤트(design.md rev2 §2.5). - ShoplivePlayerPlatform
- shoplive_player 플랫폼 인터페이스. 인자·이벤트는 wire Map(design §2.4·§2.5).
- 시청자가 공유 버튼을 눌렀다(SDK 3.0.4+, SMV-1899) — 앱이 info로 공유 화면을 띄운다.
- ShoplivePlayerStateChanged
- ShoplivePlayerUnknownEvent
- 매핑 불가·미지·형식 오류 이벤트(N-03). rawType은 디버그 표시용.
- ShoplivePlayOptions
- start/play 옵션. null 필드는 SDK 기본값(design §2.4 PlayOptions).
- ShopliveProfileUser
- id는 필수(SDK @NotNull, default 없음). gender 생략 시 SDK 기본값.
-
공유 요청 정보(ShoplivePlayerShareRequested, SDK 3.0.4+ — SMV-1899). 필드 이름은 네이티브
ShopliveShareInfo와 같다. 모든 필드는 nullable: 원천이 없으면 null이다(SDK가 지어 채우지 않음). iOS는 URL로 해석하지 못한 url·thumbnailUrl도 null로 준다(플랫폼 차이). - ShopliveSoundOptions
- ShopliveTokenUser
- ShopliveUser
-
Shoplive.setUser사용자(design.md rev2 §2.4). - ShopliveUserNameUpdateRequested
- ShopliveWebCommandReceived
Enums
- ShopliveCampaignListOrder
-
scheduledAt기준 정렬. - ShopliveCampaignListStatus
- 요청 필터 상태. 응답 표기 상태(ShopliveCampaignLifecycleStatus)와 달리 3종만 있다. ready는 예정·대기·리허설 중(응답에는 reserved가 섞일 수 있다), onAir는 방송 중(종료 진행 중 포함), closed는 다시보기 가능한 종료 방송.
- ShopliveCampaignStatus
- ShopliveCloseReason
- 플레이어가 닫힌 이유(SDK 3.0.4, SMV-1899). ShoplivePlayerState.closed의 stateChanged에만 실린다.
- ShopliveConnectionState
- ShopliveGender
- 프로필 성별(wire: design.md rev2 §2.3).
- ShopliveOverlayUIMode
- ShoplivePipPosition
- ShoplivePipRatio
- ShoplivePlaybackEventKind
- ShoplivePlayerState
- ShoplivePlayerType
- ShoplivePresentationStyle
- ShopliveResizeMode
- 영상 화면 맞춤.
- ShopliveResultAlertType
- ShopliveResultStatus
Typedefs
-
ShopliveRequestResponder<
R> = Future< bool> Function(String requestId, R result)