API: Shoplive Preview

    API: Shoplive Preview


    기사 요약

    Shoplive에서 제공하는 ShopLivePreview 컴포넌트를 통해서 프리뷰를 직접 구현할 수 있습니다.

    <cloud.shoplive.sdk.ShopLivePreview
        android:id="@+id/shoplivePlayerView"
        android:layout_width="width"
        android:layout_height="height" />


    setCampaignKey

    방송 key를 미리 설정합니다.

    fun setCampaignKey(campaignKey: String?)

    Parameter name

    Type

    Description

    campaignKey

    String?

    방송 key


    setCampaignKey

    Referrer를 미리 설정합니다.

    fun setReferrer(referrer: String?)

    Parameter name

    Type

    Description

    referrer

    String?

    referrer


    initializePlayer

    미리보기 플레이어의 초기 설정을 합니다.

    fun initializePlayer()


    start

    미리보기 재생을 시작합니다. (initializePlayer, prepare, play를 바로 실행합니다.)

    fun start()
    fun start(accessKey: String?, campaignKey: String?, referrer: String? = null)

    Parameter name

    Type

    Description

    accessKey

    String?

    고객사 key

    campaignKey

    String?

    방송 key

    referrer

    String?

    referrer


    prepare

    미리보기 영상을 준비합니다.

    fun prepare()


    play

    일시정지 된 미리보기를 재생합니다.

    fun play()


    pause

    미리보기를 일시정지합니다.

    fun pause()


    stop

    미리보기를 정지합니다.

    fun stop()


    release

    미리보기를 해제합니다.

    fun release()


    retry

    미리보기를 다시 실행시킵니다.

    fun retry()


    setMuted

    음소거 상태로 전환합니다.

    fun setMuted(isMuted: Boolean)


    setResizeMode

    영상의 종횡비를 유지할 수 있습니다. (Default: ShopLiveResizeMode.CENTER_CROP)

    fun setResizeMode(resizeMode: ShopLiveResizeMode)


    setLifecycleObserver

    LifecycleOwner를 등록하면 라이프 사이클에 맞게 미리보기 플레이어가 자동으로 play 또는 pause 할 수 있습니다.

    fun setLifecycleObserver(owner: LifecycleOwner)

    Parameter name

    Type

    Description

    owner

    LifecycleOwner

    LifecycleOwner


    setOnInitializeListener

    미리보기 시작 이벤트를 받을 수 있습니다.

    fun setOnInitializeListener(onInitializeListener: OnInitializeListener)


    setOnRenderedFirstFrameListener

    영상이 처음 그려질때의 이벤트를 받을 수 있습니다.

    fun setOnRenderedFirstFrameListener(onRenderedFirstFrameListener: OnRenderedFirstFrameListener)


    setOnClickListener

    미리보기 선택 이벤트를 받을 수 있습니다.

    fun setOnClickListener(listener: OnClickListener)


    setOnCloseListener

    미리보기 종료 이벤트를 받을 수 있습니다.

    fun setOnCloseLisstener(onCloseListener: OnCloseListener)


    setOnDimensionRatioListener

    미리보기 화면의 가로 세로 비율을 얻을 수 있습니다.

    fun setOnDimensionRatioListener(onDimensionRatioListener: OnDimensionRatioListener)


    setOnPlaybackStateChanged

    미리보기 플레이어의 상태를 얻을 수 있습니다.

    fun setOnPlaybackStateChanged(onPlaybackStateChanged: OnPlaybackStateChanged)


    useCloseButton

    Preview에서 닫기 버튼을 활성화할 수 있습니다.

    fun useCloseButton(use: Boolean)


    setEnabledVolumeKey

    디바이스 볼륨에 따라 음소거 해제될 수 있는 기능이 추가되었습니다.

    fun setEnabledVolumeKey(isEnabledVolumeKey: Boolean)


    setResolutionType

    Preview의 해상도를 LIVE 설정합니다. 혹은 PREVIEW으로 설정합니다. (Default : ShopLivePreviewResolutionType.PREVIEW)

    fun setResolutionType(resolutionType: ShopLivePreviewResolutionType)


    setPostCampaignImageVisible

    Preview의 종료 이미지를 보이거나 숨길 수 있는 옵션이 제공됩니다. (Default : true)

    fun setPostCampaignImageVisible(isPostCampaignImageVisible: Boolean)


    destroy

    미리보기 메모리를 해제할 수 있습니다.

    fun destroy()


    What's Next