API: Etc

mute

현재 재생 중인 영상을 음소거 합니다.

func mute()

Sample code

ShopLive.mute()

unmute

현재 재생 중인 영상을 음소거를 해제합니다.

func unmute()

Sample code

ShopLive.unmute()

getCampaigns

accessKey 에 속한 캠페인(방송) 목록과 각 캠페인의 현재 상태를 조회합니다. 호출 전에 ShopLive.configure(with:) 로 accessKey 를 설정해야 합니다. iOS SDK 1.8.15 이상에서 사용할 수 있습니다.

extension ShopLive.API {

    // completion
    @discardableResult
    static func getCampaigns(_ request: ShopLiveCampaignListRequest = ShopLiveCampaignListRequest(),
                             completion: @escaping (Result<ShopLiveCampaignListResponse, ShopLiveCommonError>) -> Void) -> ShopLiveCancellable

    // async/await (iOS 13+)
    static func getCampaigns(_ request: ShopLiveCampaignListRequest = ShopLiveCampaignListRequest()) async throws -> ShopLiveCampaignListResponse
}

참고

• completion 은 main thread 에서 호출됩니다.

• 반환값 ShopLiveCancellable 의 cancel() 로 진행 중인 요청을 취소할 수 있습니다. async 버전은 Task 가 취소되면 요청도 함께 취소됩니다.

• 요청·응답 타입은 ShopliveSDKCommon 모듈에 정의되어 있습니다. 타입 이름을 코드에서 직접 사용할 때는 import ShopliveSDKCommon 이 필요합니다.

ShopLiveCampaignListRequest

조회 조건입니다. 모든 파라미터는 선택(optional)이며, 인자 없이 ShopLiveCampaignListRequest() 를 넘기면 서버 기본값으로 전체 상태를 조회합니다.

ShopLiveCampaignListResponse

조회 결과입니다.

ShopLiveCampaign

캠페인 한 건의 정보입니다.

ShopLiveCampaign.Lifecycle

캠페인의 상태와 상태 전환 시각입니다.

ShopLiveCampaign.Status

캠페인 상태 값입니다. 서버 값이 그대로 매핑되며, 정의되지 않은 값은 .unknown 으로 전달됩니다.

ShopLiveCampaign.Metrics

시청 지표입니다. .onair / .closed 상태에서만 제공됩니다.

에러 처리

실패 시 ShopLiveCommonError 가 전달됩니다. codes 에 오류 코드가 담기며, message 는 항상 고정 문구 Failed to fetch campaign list. Refer to the error code. 입니다. 원인은 codes 로 판별하세요. 서버가 반환한 오류 코드는 그대로 전달되며, 전체 코드 목록은 Error codes 문서를 참고하세요.

Sample code

import ShopLiveSDK
import ShopliveSDKCommon

// accessKey 설정 (앱에서 최초 1회)
ShopLive.configure(with: "{accessKey}")

// 방송 중 · 준비 중인 캠페인을 최신순으로 20개 조회
let request = ShopLiveCampaignListRequest(page: 1,
                                          size: 20,
                                          statuses: [.onair, .ready],
                                          order: .descending)

let cancellable = ShopLive.API.getCampaigns(request) { result in
    switch result {
    case let .success(response):
        for campaign in response.campaigns {
            switch campaign.lifecycle.status {
            case .reserved:
                print("예약", campaign.title ?? "")
            case .ready:
                print(campaign.lifecycle.rehearsal ? "리허설 중" : "준비 중", campaign.title ?? "")
            case .onair:
                print(campaign.lifecycle.closingAt == nil ? "방송 중" : "종료 진행 중", campaign.title ?? "")
            case .closed:
                print("종료", campaign.title ?? "")
            case let .unknown(raw):
                print("알 수 없는 상태", raw)
            }
        }
        if response.hasMore {
            // page 를 1 증가시켜 다음 페이지를 조회합니다.
        }
    case let .failure(error):
        print("getCampaigns failed:", error.codes, error.message ?? "")
    }
}

// 결과가 더 이상 필요 없으면(화면 이탈 등) 요청을 취소합니다.
// cancellable.cancel()

Sample code (async/await)

// iOS 13+ — Task 가 취소되면 진행 중인 요청도 함께 취소됩니다.
Task {
    do {
        let response = try await ShopLive.API.getCampaigns(ShopLiveCampaignListRequest(statuses: [.onair]))
        let onair = response.campaigns.filter { $0.lifecycle.closingAt == nil }
        if let campaign = onair.first {
            ShopLive.play(data: ShopLivePlayerData(campaignKey: campaign.campaignKey))
        }
    } catch let error as ShopLiveCommonError {
        print("getCampaigns failed:", error.codes)
    } catch {
        // Task 취소(CancellationError) 등
    }
}