라이브러리 파라미터 레퍼런스

라이브러리 파라미터 레퍼런스 — 소스클립 플레이어

함수 목록

setInit 을 호출하면 window.SauceClipPlayerLib 가 나머지 함수를 가진 객체로 바뀝니다. 그래서 setInit 이 항상 먼저입니다.

함수	역할	호출 시점
`setInit`	파트너 ID·클립 ID·마운트 요소 등록	가장 먼저 한 번
`load`	플레이어 표시	`setInit` 이후
`setFloatingType`	플로팅 모드로 전환	`setInit` 이후 언제든
`resetFloatingType`	플로팅 해제	플로팅 모드에서
`setFloatingProductLinkUrl`	플로팅 뒤에 띄울 상품 페이지 지정	플로팅 모드에서
`setPartnerUniqueId`	파트너 ID 변경	`setInit` 이후
`getPartnerUniqueId`	현재 파트너 ID 반환	`setInit` 이후

📍 setInit 은 한 페이지에서 한 번만 적용됩니다. 두 번째 호출부터는 이미 만들어진 플레이어가 그대로 유지됩니다.

setInit

플레이어를 초기화합니다.

setInit({ partnerUniqueId, clipId, elementId })

load

초기화한 값으로 플레이어를 그립니다. 반환값은 없습니다.

load()

📍 호출 시점에 elementId 요소가 문서에 없으면 아무것도 그리지 않고 콘솔에 경고가 남습니다.

setFloatingType

플레이어를 화면에 고정된 작은 창으로 바꿉니다.

setFloatingType({ type, size, floatingPosition, restrictionArea })

파라미터	타입	필수	기본값	설명
type	`'basic'` \| `'none'`	필수	—	`'basic'` 이면 플로팅으로 전환. `'none'` 은 상태값만 바꾸고 화면은 그대로
size	Number	선택	`0.25`	크기 배율. `1` 이 원래 크기
floatingPosition	Object	선택	`{ position: 'bottom right' }`	노출 위치. 아래 표 참조
restrictionArea	Object	선택	—	드래그로 움직일 수 있는 범위. 아래 표 참조

floatingPosition

파라미터	타입	필수	기본값	설명
position	String	필수	`'bottom right'`	세로·가로를 공백으로 구분. 세로 `top` · `bottom` / 가로 `left` · `right`
offsetX	Number	선택	`0`	가로 여백에 더할 값(px). 기본 여백은 20px
offsetY	Number	선택	`0`	세로 여백에 더할 값(px). 기본 여백은 20px

restrictionArea

파라미터	타입	필수	기본값	설명
element	HTMLElement	선택	—	범위가 될 요소. `elementId` 보다 우선
elementId	String	선택	—	범위가 될 요소의 ID

resetFloatingType

플로팅을 해제하고 원래 자리로 되돌립니다. size 는 기본값으로, 상품 페이지 지정은 빈 값으로 초기화됩니다.

resetFloatingType()

setFloatingProductLinkUrl

플로팅 플레이어 뒤에 상품 페이지를 전체 화면 iframe 으로 띄웁니다.

setFloatingProductLinkUrl(url)

파라미터	타입	필수	기본값	설명
url	String	필수	—	상품 페이지 주소. 빈 값이면 아무 동작도 하지 않음

⚠️ 상품 페이지가 라이브러리를 넣은 페이지와 다른 도메인이면 iframe 대신 그 주소로 페이지가 이동합니다. 동작 조건은 상품 페이지 연동 플로팅에 있습니다.

setPartnerUniqueId · getPartnerUniqueId

파트너 ID를 바꾸거나 현재 값을 읽습니다.

setPartnerUniqueId(partnerUniqueId)

파라미터	타입	필수	기본값	설명
partnerUniqueId	String	필수	—	파트너 ID. 빈 값이면 무시되고 콘솔에 경고가 남음

getPartnerUniqueId()

반환	타입	설명
파트너 ID	String \| null	등록된 값이 없으면 빈 문자열