Shortform API

숏폼 상세 재생

ShopLiveShortform.play(requestData: ShopLiveShortformCollectionData?)를 통해 Shortform 상세화면을 재생합니다. (ShopLiveShortformCollectionData에 연관된 재생 목록)

• ShopLiveShortformCollectionData의 필드 값 중 하나 이상 넣으면 관련 상세화면을 재생할 수 있습니다.

• ShopLiveShortformCollectionData이 null이라면 전체 상세화면을 재생할 수 있습니다.

ShopLiveShortformCollectionData

숏폼 상세 View: 전체

let requestCollectionData = ShopLiveShortformCollectionData()
ShopLiveShortform.play(requestData: requestCollectionData)

숏폼 상세 View: 목록 클릭 후 상세 재생

let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.shortsId = "{YOUR_SHORTS_ID}"
requestCollectionData.shortsSrn = "{YOUR_SHORTS_SRN}"
ShopLiveShortform.play(requestData: requestCollectionData)

숏폼 상세 View: 연관 태그 목록 클릭 후 재생

let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.shortsId = "{YOUR_SHORTS_ID}"
requestCollectionData.shortsSrn = "{YOUR_SHORTS_SRN}"
requestCollectionData.tags = ["testTag1","testTag2"]
requestCollectionData.tagSearchOperator = .OR
ShopLiveShortform.play(requestData: requestCollectionData)

숏폼 상세 View: 연관 브랜드 목록 클릭 후 재생

let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.shortsId = "{YOUR_SHORTS_ID}"
requestCollectionData.shortsSrn = "{YOUR_SHORTS_SRN}"
requestCollectionData.brands = ["brand1","brand2"]
ShopLiveShortform.play(requestData: requestCollectionData)

숏폼 상세 View: 연관 태그 재생

let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.tags = ["testTag1","testTag2"]
requestCollectionData.tagSearchOperator = .OR
ShopLiveShortform.play(requestData: requestCollectionData)

숏폼 상세 View: 연관 브랜드 재생

let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.brands = ["brand1","brand2"]
ShopLiveShortform.play(requestData: requestCollectionData)

UIView 기반으로 숏폼 상세 재생

ShopLiveShortsCollectionView를 통해 Shortform 상세화면을 재생합니다.

• init(requestData : ShopLiveShortformCollectionData?)

  • 자세한 API 설명은 다음 링크를 참조해주세요 . 숏폼 상세 재생

• init(shortformIdsData : ShopLiveShortformIdsData, dataSourceDelegate : ShortsCollectionViewDataSourcRequestDelegate, shortsCollectionDelegate : ShopLiveShortformReceiveHandlerDelegate?)

  • 자세한 API 설명은 다음 링크를 참조해주세요. 특정 Shortform ID로 숏폼 상세 목록 구성

class ViewController : UIViewController {
    //숏폼 상세 재생
    lazy var shortsCollectionView : ShopLiveShortsCollectionView = {
        let requestData = ShopLiveShortformCollectionData(reference: "REFERENCE",
                                                          shortsId: "SHORTS_ID",
                                                          tags: ["TAG"],
                                                          tagSearchOperator: .OR,
                                                          brands: ["BRAND"],
                                                          shuffle: true,
                                                          referrer: "{REFFERER}",
                                                          skus: ["SKU"],
                                                          shortsCollectionId: "{SHORTS_COLLECTION_ID}",
                                                          delegate: self)
        
        let view = ShopLiveShortsCollectionView(requestData: requestData)
        view.translatesAutoresizingMaskIntoConstraints = false
        return view
    }()
    
    //특정 Shortform ID로 숏폼 상세 목록 구성
    lazy var shortsCollectionView : ShopLiveShortsCollectionView = {
        let shortsIdData = ShopLiveShortformIdData(shortsId: "{SHORTS_ID}", payload: ["CUSTOM_DATA" : "CUSTOM_DATA"])
        let shorformIdsData = ShopLiveShortformIdsData(ids: shortsIdData)
        let view = ShopLiveShortsCollectionView(shortformIdsData: shorformIdsData,
                                                dataSourceDelegate: self,
                                                shortsCollectionDelegate: self)
        view.translatesAutoresizingMaskIntoConstraints = false
        return view
    }()
}
extension ViewController { 
    private func setLayout() {
        self.view.addSubview(shortsCollectionView)
        
        NSLayoutConstraint.activate([
            shortsCollectionView.topAnchor.constraint(equalTo: self.view.topAnchor,constant: 60),
            shortsCollectionView.leadingAnchor.constraint(equalTo: self.view.leadingAnchor),
            shortsCollectionView.trailingAnchor.constraint(equalTo: self.view.trailingAnchor),
            shortsCollectionView.bottomAnchor.constraint(equalTo: self.view.bottomAnchor)
        ])
    }
}

ShopLiveShortsCollectionView 전용 API

• ShopLiveShortsCollectionView Action
  ShopLiveShortsCollectionView는 .action()을 통하여 명령을 내릴 수 있습니다.

var shortsCollectionView : ShopLiveShortsCollectionView
shortsCollectionView.action( .play ) 

ShopLiveShortsCollectionView Action

override func viewWillTransition(to size: CGSize, with coordinator: any UIViewControllerTransitionCoordinator) {
    guard let shortsCollectionView = shortsCollectionView else { return }
    shortsCollectionView.action( .onStartRotation(size: size) )
    coordinator.animate { [weak self] context in
        shortsCollectionView.action( .onChangingRotation(size: size) )
    } completion: { [weak self] context in
        shortsCollectionView.action( .onFinishedRotation(size: size) )
    }
}

숏폼 프리뷰 재생

ShopLiveShortform.showPreview(requestData: ShopLiveShortformPreviewData?)를 통해 Shortform 미리보기를 재생합니다. ( ShopLiveShortformRelatedData에 연관된 재생 목록 )

• ShopLiveShortformRelatedData의 필드 값 중 하나 이상 넣으면 관련 미리보기를 재생 할 수 있습니다.

ShopLiveShortformRelatedData

ShopLiveShortformPreviewData

숏폼 프리뷰: ProductId 기반

let requestRelatedData = ShopLiveShortformRelatedData()
requestRelatedData.productId = "{YOUR_PRODUCT_ID}"
ShopLiveShortform.showPreview(requestData: requestRelatedData)

숏폼 프리뷰: SKU 기반

let requestRelatedData = ShopLiveShortformRelatedData()
requestRelatedData.sku = "{YOUR_PRODUCT_SKU}"
ShopLiveShortform.showPreview(requestData: requestRelatedData)

숏폼 프리뷰: Tag 기반

let requestRelatedData = ShopLiveShortformRelatedData()
requestRelatedData.tags = ["tag1","tag2"]
requestRelatedData.tagSearchOperator = .OR
ShopLiveShortform.showPreview(requestData: requestRelatedData)

숏폼 프리뷰: Brand 기반

let requestRelatedData = ShopLiveShortformRelatedData()
requestRelatedData.brands = ["brand1","brand2"]
ShopLiveShortform.showPreview(requestData: requestRelatedData)

숏폼 상세 / 프리뷰 종료

현재 실행중인 숏폼 상세 혹은 프리뷰를 닫습니다.

ShopLiveShortform.close()

숏폼 상세 내 버튼 숨김

setVisibleFullTypeViews(options: ShopLiveShortformVisibleFullTypeData)를 통해 숏폼 상세 뷰에 버튼 노출 여부를 설정합니다. ShopLiveShortformVisibleFullTypeData의 필드 값 중 하나 이상 넣으면 관련 버튼 노출 여부를 설정할 수 있습니다.

ShopLiveShortformVisibleFullTypeData

var option = ShopLiveShortformVisibleFullTypeData()
option.isLikeButtonVisible = true
option.isCommentButtonVisible = true
option.isShareButtonVisible = true
option.isBookMarkVisible = true
ShopLiveShortform.setVisibleFullTypeViews(options: option)

특정 Shortform ID로 숏폼 상세 목록 구성

ShopLiveShortform.play(shortformIdsData: ShopLiveShortformIdsData, delegate: ShortsCollectionViewDataSourceRequestDelegate)를 통해 숏폼 API로 받아온 shortformId를 통해 playlist를 구성하고 순서대로 재생합니다.

ShopLiveShortformIdsData

ShopLiveShortformIdData

ShortsCollectionViewDataSourcRequestDelegate

protocol ShortsCollectionViewDataSourceDelegate : AnyObject { 
     func onShortformListPagination(completion : @escaping((ShopLiveShortformIdsMoreData?,Error?) -> ()))
     func onShortformListPaginationError(error : Error)
}

onShortformListPagination(completion:_) 함수는 더 이상 보여줄 숏폼의 ID가 없을 때 호출됩니다. 이런 상황에서 completion(ShopLiveShortformIdsMoreData)을 통해서 숏폼의 ID를 계속 공급하여 지속적으로 숏폼이 나오게 합니다.

ShopLiveShortformIdsMoreData

숏폼 상세 종횡비 유지

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

ShopLiveShortform.setResizeModel(option : ShopLiveResizeMode)