API

API — 소스라이브 플레이어 iOS SDK

📘 레퍼런스

📋 연동 방법은 Quickstart 참고

앱에서 호출하는 메서드입니다.
대부분의 연동은 아래 네 개로 끝납니다 — 초기화, 인스턴스 생성, 실행, 콜백 등록.

PLAY — 초기화와 실행

메서드	파라미터	설명
`SauceClient.initInstance`	`activationKey` 필수 `apiHost` 선택	SDK 를 초기화합니다. `AppDelegate` 에서 한 번만 호출하세요. `apiHost` 는 `.stage`(테스트) 또는 `.prod`(운영). 생략하면 `.stage` 입니다 → 1. SDK 설치하기
`SauceLivePlayerClient.getInstance`	`broadcastID` 필수 `token` 선택 `viewController` 필수	플레이어 인스턴스를 만듭니다. `viewController` 는 플레이어를 담을 컨테이너입니다. `token` 을 생략하면 게스트로 시청합니다 → 2. 플레이어 실행하기
`startPlayer()`	없음	플레이어를 컨테이너의 자식 화면으로 추가하고 재생을 시작합니다. 콜백을 모두 등록한 뒤 호출하세요
`closePlayer()`	없음	플레이어를 정리하고 컨테이너에서 제거합니다. 시청자가 닫은 경우는 `onClose` 로 옵니다

PIP — 작은 창

메서드	파라미터	설명
`PIPKit.show`	`with` 필수 `completion` 선택	플레이어를 앱 화면 위에 떠 있는 창으로 표시합니다. 전체화면으로 시작합니다 — 작은 창으로 시작할 수 없습니다 → D. PIP 설정하기
`PIPKit.dismiss`	`animated` 필수 `completion` 선택	떠 있는 창을 닫습니다
`startPIPMode()`	없음	전체화면 → 작은 창으로 전환합니다. 위치·크기는 SDK 고정값입니다
`stopPIPMode()`	없음	작은 창 → 전체화면으로 복귀합니다

ETC — 조회와 설정

메서드 · 프로퍼티	반환	설명
`SauceClient.isInitialized`	`Bool`	초기화 여부. 플레이어를 만들기 전에 확인하면 안전합니다
`SauceClient.isLiveEnabled()`	`Bool`	활성화 키에 라이브 사용 권한이 있는지
`SauceClient.partnerID`	`String?`	활성화 키에서 확인된 파트너 ID
`PIPKit.isActive`	`Bool`	떠 있는 창이 표시 중인지. 중복 실행 방지에 사용합니다
`PIPKit.isPIP`	`Bool`	현재 작은 창 상태인지
`setAPIHost(_:)` · `getAPIHost()`	—	인스턴스별 서버 환경. 보통 초기화에서 정하므로 쓰지 않습니다

⚠️ 초기화 없이 getInstance 를 부르면 앱이 종료됩니다 — 초기화 여부와 라이브 권한을 내부에서 검사하고, 통과하지 못하면 실행을 중단합니다. SauceClient.isInitialized 로 먼저 확인하세요.

💡 쓰지 말아야 할 것 — SauceLivePlayerClient.initInstance(partnerID:apiHost:) 는 더 이상 사용하지 않습니다. 초기화는 SauceClient.initInstance 하나로 합니다.