브릿지 이벤트 레퍼런스
자사몰에서 처리할 수 있는 브릿지 이벤트의 이름과 이벤트 값 구조입니다. 자사몰 페이지에서는 소스라이브 플레이어 웹 SDK의 SauceLive.Player('on', …)로 이벤트를 수신하고, 앱이 플레이어 주소를 웹뷰로 바로 열면 Android @JavascriptInterface, iOS WKScriptMessageHandler로 수신합니다.
SauceLive.Player('on', 이벤트 이름, 처리 함수)로 수신하고, 명령은 SauceLive.Player('명령', 인자)로 호출합니다. 위치 · 열림 · 오류 같은 나머지 이벤트와 시작 옵션은 라이브러리 파라미터 레퍼런스에 있습니다. 값 표의 「필수」는 항상 들어 있는 필드이고, 타입에 null이 있으면 값이 null일 수 있습니다.앱이 플레이어 주소를 웹뷰로 바로 열 때 주고받는
sauceflex… 이름은 맨 아래 앱 웹뷰 이름 절에 있습니다.
saucelive-player.min.js 스크립트가 실행되기 전에 호출한 명령은 Promise를 돌려주지 않으므로, 결과를 받을 명령은 페이지가 로드된 뒤에 호출하세요.| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| protocol | 1 | 2 | 필수 | 플레이어 통신 규약 버전 |
broadcastStateCode를 통해 현재 방송 상태를 파악할 수 있습니다.| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| broadcastStateCode | String | null | 필수 | 방송 상태 코드. 예: 'onair' · 'ready' · 'vod' |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 값 없음 | |||
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| pvCount | Number | null | 필수 | 누적 조회 수. 집계 전이면 null |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| currentTime | Number | 필수 | 영상 처음부터 센 재생 위치(초) |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| isMuted | Boolean | 필수 | true: 소리 꺼짐 / false: 소리 켜짐 |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| couponList | Array | 필수 | 달성한 쿠폰 목록 |
broadcastId로 방송마다 처리를 구분할 수 있습니다.
linkUrl로 이동합니다. 자세한 구현은 상품 클릭 연동 가이드에 있습니다.| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| linkUrl | String | null | 필수 | 상품 페이지 주소 |
| price | Number | String | null | 필수 | 상품 가격 |
| externalProductId | String | null | 필수 | 어드민에 등록한 외부 상품 코드. 등록하지 않은 상품은 null |
| isSoldout | Boolean | 필수 | 품절 여부 |
| scheme | { url, webUrl } | 선택 | 앱 웹뷰로 연 자사몰 페이지에서, 어드민에 앱스킴을 넣은 항목을 클릭할 때만 들어 있습니다. url 앱스킴 · webUrl 웹 주소 |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| externalProductId | String | null | 필수 | 외부 상품 코드 |
externalProductId로 자사몰 상품을 식별하고 장바구니 담기 처리를 수행합니다. 등록하지 않으면 플레이어가 상품 시트를 닫습니다.| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| externalProductId | String | null | 필수 | 외부 상품 코드 |
linkUrl로 이동하고, tel: 배너는 휴대폰에서 전화를 겁니다. 다른 동작이 필요하면 등록해 커스텀 동작을 정의하세요.| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| bannerId | String | null | 필수 | 배너 ID |
| linkUrl | String | null | 필수 | 배너 링크 주소 |
| scheme | { url, webUrl } | 선택 | 앱 웹뷰로 연 자사몰 페이지에서, 어드민에 앱스킴을 넣은 항목을 클릭할 때만 들어 있습니다. url 앱스킴 · webUrl 웹 주소 |
target에 따라 같은 창 또는 새 창으로 엽니다. 등록했다면 target으로 현재 창 또는 새 창 여부를 구분하세요.| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| slotBannerId | String | null | 필수 | 슬롯 배너 ID |
| url | String | null | 필수 | 이동할 주소. 앱스킴 클릭이면 앱스킴 주소 |
| target | 'BLANK' | 'SELF' | 필수 | 'BLANK': 새 창 / 'SELF': 같은 창 |
| scheme | { url, webUrl } | 선택 | 앱 웹뷰로 연 자사몰 페이지에서, 어드민에 앱스킴을 넣은 항목을 클릭할 때만 들어 있습니다. url 앱스킴 · webUrl 웹 주소 |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| couponType | String | null | 필수 | 'link' · 'newWindow' · 'download' · 'custom' |
| couponCode | String | null | 필수 | 쿠폰 코드 |
| couponId | String | null | 필수 | 쿠폰 ID |
| couponName | String | null | 필수 | 쿠폰 이름 |
| linkUrl | String | null | 필수 | 이동할 주소 |
| metaData | String | null | 필수 | 사용자 정의 데이터(JSON 문자열) |
| scheme | { url, webUrl } | 선택 | 앱 웹뷰로 연 자사몰 페이지에서, 어드민에 앱스킴을 넣은 항목을 클릭할 때만 들어 있습니다. url 앱스킴 · webUrl 웹 주소 |
linkUrl로 이동합니다. 자세한 구현은 리워드 연동 가이드에 있습니다.| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| linkUrl | String | null | 필수 | 리워드 연결 URL |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| shopId | String | null | 필수 | 상점 ID |
| shopName | String | null | 필수 | 상점 이름 |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
respondToNotification 명령으로 플레이어에 다시 전송합니다. 전체 흐름은 라이브 알림 버튼 연동 가이드에 있습니다.| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| broadcastId | String | 필수 | 라이브 ID |
| requestId | String | 필수 | respondToNotification에 넘길 요청 ID |
| state | 'on' | 'off' | 필수 | 신청 · 해제 |
| programmingStartDt | String | null | 필수 | 라이브 시작 예정 시간(UTC) |
| programmingEndDt | String | null | 필수 | 라이브 종료 예정 시간(UTC) |
| 인자 | 타입 | 필수 | 설명 |
|---|---|---|---|
| requestId | String | 필수 | notificationRequest로 받은 요청 ID |
| result | 'success' | 'fail' | 'cancel' | 필수 | 처리 결과. 그 밖의 값이면 INVALID_OPTIONS로 실패합니다 |
logOut과 동작이 같습니다. 로그아웃 처리| 인자 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 인자 없음 | |||
NOT_OPEN으로 실패합니다.| 인자 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 인자 없음 | |||
| 인자 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 인자 없음 | |||
| 인자 | 타입 | 필수 | 설명 |
|---|---|---|---|
| elementId | String | 선택 | 닫힌 플레이어 창 이름. 그 창을 연 버튼으로 포커스가 돌아갑니다. 생략하면 포커스를 이동하지 않습니다. 예: 'share-bottom-sheet'(공유 버튼) |
| delayMs | Number | 선택 | 돌려놓기까지 기다릴 시간(ms) |
| 인자 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 문구 | String | 필수 | 띄울 문구 |
라이프사이클 이벤트를 console.log로 확인하는 디버깅용 리스너입니다. 개발 초기 단계용입니다. 클릭 이벤트는 실제 처리 함수를 만든 뒤 하나씩 등록하세요.
// 라이프사이클 이벤트만 로그로 확인한다. 클릭 이벤트를 등록하면 그 클릭의 기본 동작이 실행되지 않는다 ['ready', 'broadcastStatusChange', 'firstPlay', 'pvCountChange', 'timeUpdate', 'muteChange', 'rewardCouponIssue'] .forEach((name) => { SauceLive.Player('on', name, (e) => console.log(name, e)) })
앱이 플레이어 주소를 웹뷰로 바로 열 때 네이티브 브릿지로 주고받는 이름입니다. 위의 웹 SDK on() 이벤트·명령과는 다른 이름이고, 웹 SDK를 설치한 자사몰 페이지에서는 쓰지 않습니다. 웹 SDK 없이 플레이어를 iframe으로 넣은 페이지도 같은 이름을 씁니다. 앱이 그 이름을 등록하지 않았으면 부모 페이지가 postMessage로 받습니다(iframe 연동 가이드).
브릿지 등록과 보내는 방법은 앱 웹뷰 브릿지에 있습니다.
플레이어가 앱 브릿지로 보내는 이름과 값입니다. 앱은 받을 이름만 등록하세요. 오른쪽 열은 웹 SDK를 설치한 자사몰 페이지에서 같은 일을 받는 이벤트입니다.
…Scheme 이름은 어드민에 앱스킴을 넣은 항목을 클릭할 때 호출됩니다. 앱은 url(쿠폰은 schemeUrl)의 앱스킴을 열고, 열지 못하면 webUrl로 이동하세요.
| 이름 | 값 | 자사몰 페이지에서는 |
|---|---|---|
sauceflexEnter | 없음 | ready |
sauceflexBroadcastStatus | broadcastStateCode | broadcastStatusChange |
sauceflexFirstPlay | 없음 | firstPlay |
sauceflexUpdatePvCount | pvCount | pvCountChange |
sauceflexSendPlayTime | position(초) | timeUpdate |
sauceflexPlayerMuteStatus | isMute | muteChange |
sauceflexIssueCoupon | 쿠폰 목록(배열) | rewardCouponIssue |
sauceflexMoveLogin | Android 없음(설정에 따라 일부 파트너는 JSON 문자열) · iOS broadcastId · shopId · shopName. 앱은 로그인 뒤 accessToken 쿼리를 붙인 플레이어 주소를 다시 불러옴 | loginClick |
sauceflexMoveProduct | linkUrl · broadcastIdx · price · externalProductId · isSoldout | productClick |
sauceflexProductAndroidSchemesauceflexProductIosScheme | sauceflexMoveProduct의 linkUrl 대신 url(앱스킴) · webUrl | productClick |
sauceflexMoveProductLayer | externalProductId | productLayerClick |
sauceflexMoveCart | externalProductId | cartClick |
sauceflexMoveBanner | linkUrl · broadcastIdx · bannerId | bannerClick |
sauceflexBannerAndroidSchemesauceflexBannerIosScheme | url · broadcastIdx · bannerId · webUrl | bannerClick |
sauceflexMoveSlotBanner | slotBannerId · broadcastId · url · webUrlTargetTypeCode('BLANK' · 'SELF') | slotBannerClick |
sauceflexSlotBannerAndroidSchemesauceflexSlotBannerIosScheme | sauceflexMoveSlotBanner 값 · webUrl. url은 앱스킴 | slotBannerClick |
sauceflexMoveCoupon | broadcastIdx · couponType · couponCode · couponId · couponName · linkUrl · metaData. apiDownload 쿠폰은 플레이어가 API를 직접 호출하므로 호출하지 않음 | couponClick |
sauceflexCouponAndroidSchemesauceflexCouponIosScheme | sauceflexMoveCoupon 값 · schemeUrl | couponClick |
sauceflexMoveReward | broadcastIdx · linkUrl | rewardClick |
sauceflexOnShare | linkUrl · shortUrl · broadcastIdx · broadcastThumbnailUrl · broadcastName | shareClick |
sauceflexMoveExit | 없음 | closeClick |
sauceflexPictureInPicture | 없음. PIP 창은 앱이 구현 | pipClick |
sauceflexTurnOnNotificationsauceflexTurnOffNotification | accessToken · broadcastId · broadcastUrl · memberId · partnerUniqueId · programmingStartDt · programmingEndDt | notificationRequest |
sauceflexSendAppsFlyerEvent | event · params | 없음 |
앱이 웹뷰에서 window.postMessage(JSON.stringify({ key, params }), '*')로 보내는 key와 params입니다.
| 이름 | 값 | 자사몰 페이지에서는 |
|---|---|---|
sauceflexEnterAsGuest | 없음 | enterAsGuest. sauceflexEnter를 받은 직후에만 반영 |
sauceflexTurnOnNotificationCallbacksauceflexTurnOffNotificationCallback | broadcastId · result('success' · 'fail' · 'cancel'). 보내지 않으면 알림 버튼이 잠긴 채 남음 | respondToNotification |
sauceflexPlaysauceflexPausesauceflexPlayLive | 없음 | play · pause · playLive |
sauceflexFloatingModeMuteOnsauceflexFloatingModeMuteOff | 없음 | mute · unmute |
sauceflexFocusBack | elementId · delayMsec | restoreFocus |
sauceflexOpenCustomToast | 문구(문자열) | showToast |
sauceFlexPIP | true PIP 시작 · false PIP 해제 | 없음 |
sauceflexWebviewReloading | 없음 | 없음. Android에서 재생을 다시 시작 |
Updated 4 days ago
