본문으로 건너뛰기

API 레퍼런스

KollusBookmark 클래스

#import <KollusBookmark.h>

속성

속성설명
NSTimeInterval position북마크 시간
NSDate * time북마크 생성된 일시
NSString * title북마크 타이틀(인덱스:강사용)
NSString * value북마크 타이틀(사용자)
KollusBookmarkKind kind북마크 종류

속성 문서화

속성설명
(KollusBookmarkKind) kind[read], [nonatomic], [assign]북마크 종류
(NSTimeInterval) position[read], [nonatomic], [unsafe_unretained]북마크 시간
(NSDate*) time[read], [nonatomic], [unsafe_unretained]북마크 생성된 일시
(NSString*) title[read], [nonatomic], [copy]북마크 타이틀(인덱스:강사용)
(NSString*) value[read], [nonatomic], [copy]북마크 타이틀(사용자)

KollusChat 클래스

#import <KollusChat.h>

속성

속성설명
BOOL isChatVisible채팅 화면 보여줄지 체크
BOOL isChatInfo채팅 정보 있는지 체크
NSString * chatUrl채팅 Url
BOOL isAdmin관리자 여부
BOOL isAnonymous익명 여부
NSString * roomId룸 ID
NSString * chattingServer채팅 서버
NSString * userId사용자 ID
NSString * nickName닉네임
NSString * photoUrl포토 Url

속성 문서화

속성설명
(NSString*) chattingServer[read], [write], [nonatomic], [copy]채팅 서버
(NSString*) chatUrl[read], [write], [nonatomic], [copy]채팅 Url
(BOOL) isAdmin[read], [write], [nonatomic], [unsafe_unretained]관리자 여부
(BOOL) isAnonymous[read], [write], [nonatomic], [unsafe_unretained]익명 여부
(BOOL) isChatInfo[read], [write], [nonatomic], [unsafe_unretained]채팅 정보 있는지 체크
(BOOL) isChatVisible[read], [write], [nonatomic], [unsafe_unretained]채팅 화면 보여줄지 체크
(NSString*) nickName[read], [write], [nonatomic], [copy]닉네임
(NSString*) photoUrl[read], [write], [nonatomic], [copy]포토 Url
(NSString*) roomId[read], [write], [nonatomic], [copy]룸 ID
(NSString*) userId[read], [write], [nonatomic], [copy]사용자 ID

KollusContent 클래스

#import <KollusContent.h>

속성

속성설명
NSString * company회사 이름
NSString * title콘텐츠 타이틀
NSString * course코스 이름
NSString * teacher강사 이름
NSString * snapshot스냅샷 파일 경로
NSString * thumbnail섬네일 파일 경로
NSString * mediaContentKey미디어 콘텐츠 키
NSString * synopsis시놉시스
NSString * descriptionURL상세 정보 URL
CGSize naturalSize영상 원본 사이즈
NSString * iosPlayerType플레이어 타입: hw, sw, native
KollusContentType contentType콘텐츠 타입
NSDate * DRMCheckDateDRM 체크 일시
NSDate * DRMExpireDateDRM 만료 일시
long DRMExpireCountMaxDRM 최대 카운트
long DRMExpireCountDRM 재생 카운트
NSTimeInterval DRMTotalExpirePlayTimeDRM 전체 재생 가능 시간
NSTimeInterval DRMExpirePlayTimeDRM 재생 가능 시간
BOOL DRMExpiredDRM 만료여부
BOOL DRMExpireRefreshPopupDRM 유효 기간 갱신 팝업 여부
NSTimeInterval duration콘텐츠 duration
NSTimeInterval position이어보기 시간
NSUInteger contentIndex콘텐츠 인덱스: 다운로드 콘텐츠 재생 시 사용
long long fileSize콘텐츠 파일 사이즈
long long downloadSize다운로드된 파일 사이즈
NSUInteger downloadProgress다운로드 백분율
BOOL downloaded다운로드 완료 여부
long long downloadStopSize다운로드 정지된 파일 사이즈
int downloadedTime파일 다운로드 일시

속성 문서화

속성설명
(NSString*) company[read], [nonatomic], [copy]회사이름
(NSUInteger) contentIndex[read], [nonatomic], [unsafe_unretained]콘텐츠 인덱스: 다운로드 콘텐츠 재생시 사용
(KollusContentType) contentType[read], [nonatomic], [unsafe_unretained]콘텐츠 타입
(NSString*) course[read], [nonatomic], [copy]코스명
(NSString*) descriptionURL[read], [nonatomic], [copy]상세정보 URL
(BOOL) downloaded[read], [nonatomic], [unsafe_unretained]다운로드 완료여부
(int) downloadedTime[read], [nonatomic], [unsafe_unretained]파일 다운로드 일시
(NSUInteger) downloadProgress[read], [nonatomic], [unsafe_unretained]다운로드 백분율
(long long) downloadSize[read], [nonatomic], [unsafe_unretained]다운로드 된 파일 사이즈
(long long) downloadStopSize[read], [nonatomic], [unsafe_unretained]다운로드 정지된 파일 사이즈
(NSDate*) DRMCheckDate[read], [nonatomic], [strong]DRM 체크일시
(long) DRMExpireCount[read], [nonatomic], [unsafe_unretained]DRM 재생 카운트
(long) DRMExpireCountMax[read], [nonatomic], [unsafe_unretained]DRM 최대 카운트
(BOOL) DRMExpired[read], [nonatomic], [unsafe_unretained]DRM 만료여부
(NSDate*) DRMExpireDate[read], [nonatomic], [strong]DRM 만료일시
(NSTimeInterval) DRMExpirePlayTime[read], [nonatomic], [unsafe_unretained]DRM 재생가능 시간
(BOOL) DRMExpireRefreshPopup[read], [nonatomic], [unsafe_unretained]DRM 유효기간 갱신 팝업 여부
(NSTimeInterval) DRMTotalExpirePlayTime[read], [nonatomic], [unsafe_unretained]DRM 전체 재생가능 시간
(NSTimeInterval) duration[read], [nonatomic], [unsafe_unretained]콘텐츠 duration
(long long) fileSize[read], [nonatomic], [unsafe_unretained]콘텐츠 파일 사이즈
(NSString*) iosPlayerType[read], [nonatomic], [copy]Player 타입: hw, sw, native
(NSString*) mediaContentKey[read], [nonatomic], [copy]미디어 콘텐츠 키
(CGSize) naturalSize[read], [nonatomic], [unsafe_unretained]영상 원본 사이즈
(NSTimeInterval) position[read], [nonatomic], [unsafe_unretained]이어보기 시간
(NSString*) snapshot[read], [nonatomic], [copy]스냅샷 파일 경로
(NSString*) synopsis[read], [nonatomic], [copy]시놉시스
(NSString*) teacher[read], [nonatomic], [copy]강사명
(NSString*) thumbnail[read], [nonatomic], [copy]섬네일 파일 경로
(NSString*) title[read], [nonatomic], [copy]콘텐츠 타이틀

KollusPlayerBookmarkDelegate 프로토콜

#import <KollusPlayerBookmarkDelegate.h>

인스턴스 메서드

  • (void) - kollusPlayerView:bookmark:enabled:error:

메서드 문서화

재생 콘텐츠의 북마크 유무를 호출

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView bookmark: (NSArray *) bookmark_senabled: (BOOL) enabled error: (NSError *) error

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    bookmarksKollusBookmark 배열
    enabledYES: 북마크 있음 NO: 북마크 없음
    error에러 상세

KollusPlayerDelegate 프로토콜

#import <KollusPlayerDelegate.h>

인스턴스 메서드

  • (void) - kollusPlayerView:prepareToPlayWithError:
  • (void) - kollusPlayerView:play:error:
  • (void) - kollusPlayerView:pause:error:
  • (void) - kollusPlayerView:buffering:prepared:error:
  • (void) - kollusPlayerView:stop:error:
  • (void) - kollusPlayerView:position:error:
  • (void) - kollusPlayerView:scroll:error:
  • (void) - kollusPlayerView:zoom:error:
  • (void) - kollusPlayerView:naturalSize:
  • (void) - kollusPlayerView:playerContentMode:error:
  • (void) - kollusPlayerView:playerContentFrame:error:
  • (void) - kollusPlayerView:playbackRate:error:
  • (void) - kollusPlayerView:repeat:error:
  • (void) - kollusPlayerView:enabledOutput:error:
  • (void) - kollusPlayerView:unknownError:
  • (void) - kollusPlayerView:framerate:
  • (void) - kollusPlayerView:lockedPlayer:
  • (void) - kollusPlayerView:charset:caption:
  • (void) - kollusPlayerView:charsetSub:captionSub:
  • (void) - kollusPlayerView:thumbnail:error:
  • (void) - kollusPlayerView:mck:
  • (void) - kollusPlayerView:height:
  • (void) - kollusPlayerView:bitrate:

메서드 문서화

  • (void) kollusPlayerView: (KollusPlayerView *) view bitrate: (int) bitrate
    HLS 콘텐츠 bitrate 값 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    bitragte정보

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView buffering: (BOOL) buffering prepared: (BOOL) prepared error: (NSError *) error
    시스템의 데이터 버퍼링이 정체되거나 정체가 해소된 경우에 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    bufferingYES 버퍼링 시작
    bufferingNO 버퍼링 완료
    preparedNO 재생 준비전
    preparedYES 재생 준비후
    error에러 상세

    ℹ️ 참고

    buffering 값이 YES로 변경되기 전에 시스템에 의한 일시정지 델리게이트가 호출된 경우 buffering 값이 NO로 변경된 경우에 UI에서 PlayWithError: 메서드 호출이 필요함


  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charset: (char *) charset caption: (char *) caption
    콘텐츠의 자막 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    charset캐릭터셋
    caption출력될 자막 데이터

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charsetSub: (char *) charsetSubcaptionSub: (char *) captionSub
    콘텐츠의 서브자막 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    charsetSub캐릭터셋
    captionSub출력될 자막 데이터

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView enabledOutput: (BOOL) enabledOutputerror: (NSError *) error
    TV출력 허용 콘텐츠 속성 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    enabledOutputYES TV출력 허용
    enabledOutputNO TV출력 허용안함
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView framerate: (int) framerate
    콘텐츠의 프레임레이트 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    framerate영상 프레임레이트

  • (void) kollusPlayerView: (KollusPlayerView *) view height: (int) height
    HLS 콘텐츠 재생 중인 resolution 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    videoheight 정보

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView lockedPlayer: (KollusPlayerType) playerType
    디바이스 락 발생 시 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    lockedPlayer실행 중인 플레이어 타입

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView mck: (NSString *) mck
    미디어 콘텐츠 키를 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    미디어콘텐츠 키

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView naturalSize: (CGSize) naturalSize
    콘텐츠의 원본 영상 사이즈 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    ContentResolution영상 사이즈

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView pause: (BOOL) userInteraction error: (NSError *) error
    일시정지 된 경우에 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    userInteractionYES 사용자가 일시정지
    userInteractionNO 시스템이 일시정지
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView play: (BOOL) userInteraction error: (NSError *) error
    재생이 시작된 경우에 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    userInteractionYES 사용자가 일시정지
    userInteractionNO 전체 반복을 통해서 시작, 시스템이 시작
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playbackRate: (float) playbackRate error: (NSError *) error
    재생속도가 변경되었음

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    playbackRate변경된 재생속도
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentFrame: (CGRect) contentFrame error: (NSError *) error
    재생화면 사이즈가 변경되었음

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    playbackRate변경된 재생속도
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentMode: (KollusPlayerContentMode) playerContentMode error: (NSError *) error
    재생화면 모드가 변경되었음

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    playContentMode변경된 재생 화면 모드
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView position: (NSTimeInterval) position error: (NSError *) error
    재생위치가 변경되기 전후에 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    position변경되는 재생시간 값
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView prepareToPlayWithError: (NSError *) errorprepareToPlay
    호출 후 콘텐츠 재생준비 완료여부를 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    error에러 상세

    ℹ️ 참고

    error가 nil이 아닌 경우 재생준비 실패


  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView repeat: (BOOL) repeat error: (NSError *) error
    반복재생모드가 변경되었음

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    repeatYES 반복 재생 설정 모드로 변경
    repeatNO 반복 재생 해제 모드로 변경
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView scroll: (CGPoint) distance error: (NSError *) error
    영상화면 이동 동작 전후에 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    distance영상 이동 거리
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView stop: (BOOL) userInteraction error: (NSError *) error
    재생이 정지된 경우에 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    userInteractionYES 사용자가 종료
    userInteractionNO 끝까지 재생되어 종료, 시스템이 종료
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView thumbnail: (BOOL) isThumbnail error: (NSError *) error
    섬네일 비동기 다운로드 완료를 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    섬네일유무
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView unknownError: (NSError *) error
    기타 에러 발생 시 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    error에러 상세

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error
    비디오 출력화면 확대/축소 전후에 전송

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    recognizerpinch 줌을 적용할 UIPinchGestureRecognizer 포인터
    error에러 상세
    반환값설명
    YES성공
    NO실패

KollusPlayerDRMDelegate 프로토콜

#import <KollusPlayerDRMDelegate.h>

인스턴스 메서드

  • (void) - kollusPlayerView:request:json:error:

메서드 문서화

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView request: (NSDictionary *) request json: (NSDictionary *) json error: (NSError *) error
    DRM Callback 전송 후 호출

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    json응답 받은 JSON 객체
    error에러 상세

KollusPlayerLMSDelegate 프로토콜

#import <KollusPlayerLMSDelegate.h>

인스턴스 메서드

  • (void) - kollusPlayerView:lmsData:resultJson:

메서드 문서화

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView lmsData:(NSString *)lmsData json resultJson:(NSDictionary *)resultJson
    LMS 정보를 서버로 전송 후 호출

    매개변수설명
    kollusPlayerViewKollusPlayerView ID
    lmsDataLMS data 정보
    resultJsonLMS result 정보


KollusPlayerView 클래스

#import <KollusPlayerView.h>

인스턴스 메서드

  • (id) - initWithContentURL:
  • (id) - initWithMediaContentKey:
  • (BOOL) - prepareToPlayWithMode:error:
  • (BOOL) - playWithError:
  • (BOOL) - pauseWithError:
  • (BOOL) - stopWithError:
  • (BOOL) - scroll:error:
  • (BOOL) - scrollStopWithError:
  • (BOOL) - zoom:error:
  • (BOOL) - addBookmark:value:error:
  • (BOOL) - removeBookmark:error:
  • (void) - setNetworkTimeOut:
  • (void) - setBufferingRatio:
  • (BOOL) - isOpened
  • (BOOL) - setSkipPlay
  • (void) - changeBandWidth:
  • (bool) - setSubTitlePath:
  • (bool) - setSubTitleSubPath:`
  • (CGRect) - getVideoPosition
  • (CGFloat) - getZoomValue
  • (void) - setPauseOnForeground:
  • (void) - setDisableZoomOut:
  • (void) - setDecoder:
  • (void) - setAIRate:

속성

속성설명
id< KollusPlayerDelegate > delegate플레이어 관련 델리게이트
id< KollusPlayerDRMDelegate > DRMDelegateDRM 정보 관련 델리게이트
id< KollusPlayerLMSDelegate > LMSDelegateLMS 정보 관련 델리게이트
id< KollusPlayerBookmarkDelegate > bookmarkDelegate북마크 관련 델리게이트
KollusStorage * storageKollusStorage 포인터
NSString * contentURL재생할 콘텐츠 URL(Stream Play)
NSString * mediaContentKey재생할 콘텐츠 Media Content Key (Local Play)
KollusContent * content사용 중인 콘텐츠 정보
BOOL AIRateEnableAI 배속 지원 여부
NSTimeInterval currentPlaybackTime콘텐츠 현재 시간
NSTimeInterval liveDuration라이브 타임쉬프트 Duration
float currentPlaybackRate
NSArray * bookmarks북마크 정보 배열
KollusPlayerContentMode scalingMode콘텐츠 출력 모드
CGRect playerContentFrame플레이어 화면 영역
KollusPlayerRepeatMode repeatMode전체 반복 모드
BOOL screenConnectEnabled화면 출력 허용 여부
BOOL bookmarkModifyEnabled북마크 수정 권한 여부
BOOL debug디버그 로그 출력여부
BOOL isPreparedToPlay재생 준비 완료여부
BOOL isPlaying재생 중 여부
BOOL isBuffering버퍼링 진행 여부
BOOL isSeeking탐색 중 여부
BOOL isScrolling화면 이동 중 여부
BOOL isAudioOnly오디오 콘텐츠 여부
BOOL muteOnStart시작 시 mute 여부
CGSize naturalSize원본콘텐츠 영상사이즈
BOOL isZoomedInZoom in 여부
KollusPlayerType playerType플레이어 타입
NSString * customSkin플레이어 스킨 정보 JSON Data
KPSection * playSection미리보기 정보
NSInteger nRepeatStartTimeRepeat Start Time.
NSInteger nRepeatEndTimeRepeat End Time.
BOOL audioBackgroundPlay백그라운드 오디오파일 재생
BOOL lmsOffDownloadContent다운로드 콘텐츠 lms off
NSUInteger proxyPortProxy Server Port 지정
BOOL intro인트로 여부
BOOL seekableseek 할 수 있는지
NSInteger nSecSkip주어진 n초 후에 skip
BOOL isLiveLive 여부
BOOL disablePlayRate배속 컨트롤 가능 여부
NSInteger nSeekableEnd
NSString * strCaptionStylePartner portal 설정값: 자막 스타일 "bg": 자막 배경 적용, "bg"가 아니면 사용자 설정
BOOL forceNScreen강제 이어보기
BOOL ignoreZero이어보기 시간 값이 작을 때에도 이어보기 유효
BOOL isThumbnailEnable섬네일 사용 여부
BOOL isThumbnailSync섬네일 다운로드 방식(sync, async)
NSString * fpsCertURLFairPlay 인증 URL.
NSString * fpsDrmURLFairPlay DRM URL.
NSInteger nOfflineBookmarkUse
NSInteger nOfflineBookmarkDownload1: 인덱스만 다운로드, 2: 인덱스/북마크 모두 다운로드
NSInteger nOfflineBookmarkReadOnly추가/삭제 사용 여부( 0:사용(기본값), 1: 사용 안함)
NSString * strVideoWaterMark
NSInteger nVideoWaterMarkAlpha비디오 워터마크 알파 값
NSInteger nVideoWaterMarkFontSize비디오 워터마크 폰트 크기
NSString * strVideoWaterMarkFontColor비디오 워터마크 칼라
NSInteger nVideoWaterMarkShowTime비디오 워터마크 보이는 시간
NSInteger nVideoWaterMarkHideTime비디오 워터마크 보이지 않는 시간
NSString * extraDrmParam동적 drm 파라메터
NSMutableArray * streamInfoListHLS ABR Information.
KollusChat * kollusChat라이브 채팅
NSInteger nextEpisodeShowTime다음 회차 재생 Show Time
NSString * nextEpisodeCallbackURL다음 회차 재생 URL
NSMutableDictionary * nextEpisodeCallbackParams다음 회차 재생 Params
BOOL nextEpisodeShowButtonContent Provider Key
NSString *contentProviderKeyContent Provider Name
NSString *contentProviderName백그라운드 재생 가능 여부
BOOL disableBackgroundAudio다음 회차 재생 Show Button
NSMutableArray * listSubTitle자막 파일 리스트
NSMutableArray * listSubTitleSub서브자막 파일 리스트

메서드 문서화

  • (BOOL) addBookmark: (NSTimeInterval) position value: (NSString *) value error: (NSError **) error
    북마크 추가

    매개변수설명
    position추가할 시간
    value북마크 타이틀
    error에러 상세
    반환값설명
    YES추가 가능
    NO추가 불가능

    ⚠️ 주의

    이미 동일한 position의 북마크가 존재할 경우 입력된 북마크로 대체됨


  • (void) changeBandWidth: (int) bandWidth
    HLS 재생중 bandwidth 변경

  • (CGRect) getVideoPosition
    비디오 영역

    반환값
    비디오 재생 위치

  • (CGFloat) getZoomValue
    비디오 출력화면 확대/축소 값

    반환값
    출력화면 확대/축소 비율 값

  • (id) initWithContentURL: (NSString *) url
    콘텐츠 URL을 사용하여 플레이어를 생성

    매개변수설명
    url재생할 콘텐츠 URL
    반환값설명
    id생성된 플레이어 ID

  • (id) initWithMediaContentKey: (NSString *) mck
    콘텐츠 인덱스를 사용하여 플레이어를 생성(다운로드 받은 콘텐츠의 경우에 사용)

    매개변수설명
    mck재생할 콘텐츠의 미디어 콘텐츠 키
    반환값설명
    id생성된 플레이어 ID

  • (BOOL) isOpened
    플레이어 생성 여부 확인

    반환값설명
    YES생성됨
    NO생성 안 됨

  • (BOOL) pauseWithError: (NSError **) error
    일시정지

    매개변수설명
    error에러 상세
    반환값설명
    YES성공
    NO실패

    ⚠️ 주의

    prepareToPlayerWithError 메서드 호출 및 성공한 경우에 사용


  • (BOOL) playWithError: (NSError **) error
    재생시작

    매개변수설명
    error에러 상세
    반환값설명
    YES성공
    NO실패

    ⚠️ 주의

    prepareToPlayerWithError 메서드 호출 및 성공한 경우에 사용


  • (BOOL) prepareToPlayWithMode: (KollusPlayerType) type error: (NSError **) error
    콘텐츠 재생 준비 (Kollus 플레이어 or 네이티브)

    매개변수설명
    type플레이어 타입
    error에러 상세
    반환값설명
    YES성공
    NO실패

  • (BOOL) removeBookmark: (NSTimeInterval) position error: (NSError **) error
    북마크 삭제

    매개변수설명
    position삭제할 북마크 시간
    error에러 상세
    반환값설명
    YES삭제 가능
    NO삭제 불가능

    ⚠️ 주의

    북마크 kind가 KollusBookmarkKindIndex인 북마크는 삭제되지 않음


  • (BOOL) scroll: (CGPoint) distance error: (NSError **) error
    비디오 출력화면을 이동

    매개변수설명
    distance이동할 거리
    error에러 상세
    반환값설명
    YES성공
    NO실패

  • (BOOL) scrollStopWithError: (NSError **) error
    비디오 출력화면 이동 중지(화면 위치 고정)

    매개변수설명
    error에러 상세
    반환값설명
    YES성공
    NO실패

  • (void) setAIRate: (bool) bAIRate
    AI 배속 사용 설정

    매개변수설명
    YES(default)YES: AI 배속, NO: 일반 배속

  • (void) setBufferingRatio: (NSInteger) bufferingRatio
    버퍼링 배수 설정

    매개변수설명
    bufferingRatio설정할 버퍼링 배수

    ⚠️ 주의

    prepareToPlayerWithError 메서드 호출 및 성공한 경우에 사용
    PlayerTypeKollus인 경우에만 적용됩니다.


  • (void) setDecoder: (bool) bHW
    코덱 설정

    매개변수설명
    `YES(default)YES: 하드웨어 코덱, NO: 소프트웨어 코덱

  • (void) setDisableZoomOut: (BOOL) bDisable
    Zoom 기능에서 zoom out 기능을 막는 API

    매개변수설명
    NO(default)zoom out(축소)기능 Enable
    YESzoom out 기능 Disable

  • (void) setNetworkTimeOut: (NSInteger) timeOut
    플레이어 네트워크 타임아웃 설정

    매개변수설명
    timeOut타임아웃 값(초)
    retryCount재시도 횟수

  • (void) setPauseOnForeground: (BOOL) bPause
    Foreground 상태로 변경 시 플레이어 재생 상태를 Pause로 유지하기 위한 API

    매개변수설명
    NO(default)포그라운드 진입시 자동재생(기존과 동일)
    YES포그라운드 진입시 pause 상태로 유지됨. APP에서 필요한 경우 Play 처리 필요

  • (BOOL) setSkipPlay
    play list중에 현재 재생중인 동영상을 skip

  • (bool) setSubTitlePath: (char *) path
    자막파일 선택

    매개변수설명
    path사용할 자막파일 경로
    반환값설명
    true성공
    false실패

  • (bool) setSubTitleSubPath: (char *) path
    서브자막파일 선택

    매개변수설명
    path사용할 자막파일 경로
    반환값설명
    true성공
    false실패

  • (BOOL) stopWithError: (NSError **) error
    재생중지

    매개변수설명
    error에러 상세
    반환값설명
    YES성공
    NO실패

    ⚠️ 주의

    prepareToPlayerWithError 메서드 호출 및 성공한 경우에 사용
    PlayerTypeKollus인 경우에만 적용됩니다.


  • (BOOL) zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error
    비디오 출력화면 확대/축소

    매개변수설명
    recognizerpinch 줌을 적용할 UIPinchGestureRecognizer 포인터
    error에러 상세
    반환값설명
    YES성공
    NO실패

속성 문서화

속성설명
(BOOL) AIRateEnable[read], [write], [nonatomic], [unsafe_unretained]AI 배속 지원 여부
(BOOL) audioBackgroundPlay[read], [write], [nonatomic], [unsafe_unretained]백그라운드 오디오파일 재생
(id<KollusPlayerBookmarkDelegate>) bookmarkDelegate[read], [write], [nonatomic], [weak]Bookmark 관련 델리게이트
(BOOL) bookmarkModifyEnabled[read], [nonatomic], [unsafe_unretained]북마크 수정권한 여부
(NSArray*) bookmarks[read], [write], [nonatomic], [strong]북마크 정보 배열
(KollusContent*) content[read], [nonatomic], [weak]사용중인 콘텐츠 정보
(NSString*) contentURL[read], [write], [nonatomic], [copy]재생할 콘텐츠 URL(Stream Play)
(float) currentPlaybackRate[read], [write], [nonatomic], [unsafe_unretained]콘텐츠 재생속도 10배속까지 지원. 경고: 2배속 초과시 품질 저하 및 오디오, 비디오 싱크가 맞지 않을 수 있음
(NSTimeInterval) currentPlaybackTime[read], [write], [nonatomic], [unsafe_unretained]콘텐츠 현재시간
(NSString*) customSkin[read], [write], [nonatomic], [copy]플레이어 스킨 정보 JSON Data
(BOOL) debug[read], [write], [nonatomic], [unsafe_unretained]디버그 로그 출력여부
(id<KollusPlayerDelegate>) delegate[read], [write], [nonatomic], [weak]플레이어 관련 델리게이트
(BOOL) disablePlayRate[read], [nonatomic], [unsafe_unretained]배속 컨트롤 가능 여부
(id<KollusPlayerDRMDelegate>) DRMDelegate[read], [write], [nonatomic], [weak]DRM 정보 관련 델리게이트
(NSString*) extraDrmParam[read], [write], [nonatomic], [copy]동적 drm 파라메터
(BOOL) forceNScreen[read], [nonatomic], [unsafe_unretained]강제 이어보기
(BOOL) ignoreZero[read], [nonatomic], [unsafe_unretained]이어보기 시간 값이 각을 때에도 이어보기 유효
(NSString*) fpsCertURL[read], [write], [nonatomic], [copy]FairPlay 인증 URL.
(NSString*) fpsDrmURL[read], [write], [nonatomic], [copy]FairPlay DRM URL.
(BOOL) intro[read], [nonatomic], [unsafe_unretained]인트로 여부
(BOOL) isAudioOnly[read], [nonatomic], [unsafe_unretained]오디오 콘텐츠 여부
(BOOL) isBuffering[read], [nonatomic], [unsafe_unretained]버퍼링 진행여부
(BOOL) isLive[read], [nonatomic], [unsafe_unretained]Live 여부
(BOOL) isPlaying[read], [nonatomic], [unsafe_unretained]재생 중 여부
(BOOL) isPreparedToPlay[read], [nonatomic], [unsafe_unretained]재생 준비 완료여부
(BOOL) isScrolling[read], [nonatomic], [unsafe_unretained]화면 이동 중 여부
(BOOL) isSeeking[read], [nonatomic], [unsafe_unretained]탐색 중 여부
(BOOL) isThumbnailEnable[read], [nonatomic], [unsafe_unretained]섬네일 사용 여부
(BOOL) isThumbnailSync[read], [nonatomic], [unsafe_unretained]섬네일 다운로드 방식(sync, async)
(BOOL) isZoomedIn[read], [nonatomic], [unsafe_unretained]Zoom in 여부
(KollusChat*) kollusChat[read], [write], [nonatomic], [assign]라이브 채팅
(NSMutableArray*) listSubTitle[read], [nonatomic], [assign]자막 파일 리스트
(NSMutableArray*) listSubTitleSub[read], [nonatomic], [assign]서브자막 파일 리스트
(NSTimeInterval) liveDuration[read], [nonatomic], [unsafe_unretained]라이브 타임쉬프트 Duration
(id<KollusPlayerLMSDelegate>) LMSDelegate[read], [write], [nonatomic], [weak]LMS 정보 관련 델리게이트
(BOOL) lmsOffDownloadContent[read], [write], [nonatomic], [unsafe_unretained]다운로드 콘텐츠 lms off
(NSString*) mediaContentKey[read], [write], [nonatomic], [assign]재생할 콘텐츠의 미디어 콘텐츠 키(Local Play)
(BOOL) muteOnStart[read], [nonatomic], [unsafe_unretained]시작 시 음소거 여부
(CGSize) naturalSize[read], [nonatomic], [unsafe_unretained]원본 콘텐츠 영상 사이즈
(NSMutableDictionary*) nextEpisodeCallbackParams[read], [nonatomic], [assign]다음 회차 재생 Params
(NSString*) nextEpisodeCallbackURL[read], [nonatomic], [copy]다음 회차 재생 URL
(NSInteger) nextEpisodeShowTime[read], [nonatomic], [unsafe_unretained]다음 회차 재생 Show Time
(BOOL) nextEpisodeShowButton[read],[nonatomic], [unsafe_unretained]다음 회차 재생 Show Button
(NSString *) contentProviderKey[read],[nonatomic], [copy]Content Provider Key
(NSString *) contentProviderName[read],[nonatomic], [copy]Content Provider Name
(BOOL) disableBackgroundAudio[read],[nonatomic], [unsafe_unretained]백그라운드 재생 가능 여부
(NSInteger) nOfflineBookmarkDownload[read], [nonatomic], [unsafe_unretained]1: 인덱스만 다운로드, 2: 인덱스/북마크 모두 다운로드
(NSInteger) nOfflineBookmarkReadOnly[read], [nonatomic], [unsafe_unretained]추가/삭제 사용 여부( 0:사용(기본값), 1: 사용 안함)
(NSInteger) nOfflineBookmarkUse[read], [nonatomic], [unsafe_unretained]오프라인 북마크는 다운로드 콘텐츠만 사용 0: 사용 안함, 1: 사용함
(NSInteger) nRepeatEndTime[read], [nonatomic], [unsafe_unretained]Repeat End Time.
(NSInteger) nRepeatStartTime[read], [nonatomic], [unsafe_unretained]Repeat Start Time.
(NSInteger) nSecSkip[read], [nonatomic], [unsafe_unretained]주어진 n초후에 skip
(NSInteger) nSeekableEnd[read], [nonatomic], [unsafe_unretained]주어진 n초까지 또는 현재 재생 초까지 Seek 할 수 있음. seekable이 false일 때만 적용 -1: seek 할 수 없음
(NSInteger) nVideoWaterMarkAlpha[read], [nonatomic], [unsafe_unretained]비디오 워터마크 알파 값
(NSInteger) nVideoWaterMarkFontSize[read], [nonatomic], [unsafe_unretained]비디오 워터마크 폰트 크기
(NSInteger) nVideoWaterMarkHideTime[read], [nonatomic], [unsafe_unretained]비디오 워터마크 보이지 않는 시간
(NSInteger) nVideoWaterMarkShowTime[read], [nonatomic], [unsafe_unretained]비디오 워터마크 보이는 시간
(CGRect) playerContentFrame[read], [write], [nonatomic], [unsafe_unretained]플레이어 화면 영역
(KollusPlayerType) playerType[read], [nonatomic], [assign]플레이어 타입
(KPSection*) playSection[read], [write], [nonatomic], [assign]미리보기 정보
(NSUInteger) proxyPort[read], [write], [nonatomic], [unsafe_unretained]Proxy Server Port 지정
(KollusPlayerRepeatMode) repeatMode[read], [write], [nonatomic], [unsafe_unretained]전체반복 모드
(KollusPlayerContentMode) scalingMode[read], [write], [nonatomic], [unsafe_unretained]콘텐츠 출력 모드
(BOOL) screenConnectEnabled[read], [nonatomic], [unsafe_unretained]화면출력 허용여부
(BOOL) seekable[read], [nonatomic], [unsafe_unretained]seek 할 수 있는지
(KollusStorage*) storage[read], [write], [nonatomic], [weak]KollusStorage 포인터
(NSString*) strCaptionStyle[read], [nonatomic], [copy]Partner portal 설정값: 자막 스타일 "bg": 자막 배경 적용, "bg"가 아니면 사용자 설정
(NSMutableArray*) streamInfoList[read], [nonatomic], [assign]HLS ABR Information.
(NSString*) strVideoWaterMark[read], [nonatomic], [copy]비디오 워터마크 비디오 워터마크 문자
(NSString*) strVideoWaterMarkFontColor[read], [nonatomic], [copy]비디오 워터마크 칼라

KollusStorage 클래스

#import <KollusStorage.h>

인스턴스 메서드

  • (BOOL) - setKollusPath:
  • (BOOL) - startStorage:
  • (BOOL) - startStorageWithFirst:error:
  • (BOOL) - startStorageWithCheck:
  • (BOOL) - startStorageWithNewPlayerID:
  • (NSString *) - loadContentURL:error:
  • (NSString *) - checkContentURL:error:
  • (BOOL) - downloadContent:error:
  • (BOOL) - removeContent:error:
  • (BOOL) - removeCacheWithError:
  • (BOOL) - downloadCancelContent:error:
  • (void) - setNetworkTimeOut:retry:
  • (void) - updateDownloadDRMInfo:
  • (void) - setCacheSize:
  • (void) - setBackgroundDownload:
  • (NSMutableArray *) - contents
  • (void) - sendStoredLms

속성

속성설명
id< KollusStorageDelegate > delegate다운로드 상태정보 델리게이트
NSString * applicationVersionKollus SDK 버전
NSString * applicationDeviceIDKollus 플레이어 디바이스 ID
NSString * applicationKeyKollus SDK 인증 키(카테노이드에서 발급)
NSString * applicationBundleID애플리케이션 Bundle ID(ex:com.yourcompany.applicationname)
NSString * keychainGroup키체인 그룹(ex:com.yourcompany.shared)
NSDate * applicationExpireDateKollus SDK 유효날짜(카테노이드에서 발급)
NSString * storagePathKollus SDK 폴더
long long storageSize다운로드 콘텐츠 총 사이즈(bytes)
long long cacheDataSize캐시데이터 총 사이즈(bytes)
NSInteger serverPort하이브리드 앱에서 사용되는 포트 번호
NSString * extraDrmParam동적 DRM 파라메터
NSString * appUserAgentUserAgent
NSString * deviceType디바이스 타입(kp-mobile, kp-tablet)

메서드 문서화

  • (NSString*) checkContentURL: (NSString *) URL error: (NSError **) error
    콘텐츠 다운로드 체크 - 전달된 URL에 해당하는 콘텐츠의 다운로드 유무 및 MCK를 확인하기 위해 사용

    매개변수설명
    URL콘텐츠 URL
    error에러 상세
    반환값
    다운로드 완료된 콘텐츠 media content key

  • (NSMutableArray*) contents
    다운로드 콘텐츠 정보 배열

  • (BOOL) downloadCancelContent: (NSString *) mediaContentKey error: (NSError **) error
    콘텐츠 다운로드를 중지

    매개변수설명
    mediaContentKey다운로드를 중지할 콘텐츠 키
    error에러 상세
    반환값설명
    YES성공
    NO실패

  • (BOOL) downloadContent: (NSString *) mediaContentKey error: (NSError **) error
    콘텐츠 다운로드 (콘텐츠 인덱스로 다운로드)

    매개변수설명
    mediaContentKey다운로드 할 콘텐츠 키
    반환값설명
    YES성공
    NO실패

  • (NSString *) loadContentURL: (NSString *) URL error: (NSError **) error
    콘텐츠 다운로드 초기화

    매개변수설명
    URL다운로드 초기화 할 콘텐츠 URL
    error에러 상세
    반환값
    초기화 완료된 콘텐츠 키 (mediaContentKey)

  • (BOOL) removeCacheWithError: (NSError **) error
    스트리밍 콘텐츠 캐시데이터 삭제

    매개변수설명
    error에러 상세
    반환값설명
    YES성공
    NO실패

  • (BOOL) removeContent: (NSString *) mediaContentKey error: (NSError **) error
    특정 콘텐츠 삭제

    매개변수설명
    mediaContentKey삭제할 콘텐츠 키
    반환값설명
    YES성공
    NO실패

  • (void) sendStoredLms
    미전송된 LMS data 전송

  • (void) setBackgroundDownload: (BOOL) bBackground
    스토리지 콘텐츠 백그라운드 다운로드 여부

  • (void) setCacheSize: (NSInteger) cacheSizeMB
    스토리지 캐쉬 사이즈 설정

    매개변수설명
    cacheSizeMB스트리밍 콘텐츠 캐쉬 사이즈(Mega Bytes)

  • (void) setNetworkTimeOut: (NSInteger) timeOut retry: (NSInteger) retryCount
    스토리지 네트워크 타임아웃 설정

    매개변수설명
    timeOut타임아웃 값(초)
    retryCount재시도 횟수

  • (BOOL) setKollusPath: (NSString *)path
    스토리지 폴더 설정

    매개변수설명
    pathkollus sdk에서 사용하는 폴더
    반환값설명
    YES성공
    NO실패

    ⚠️ 주의

    이 메서드는 신규 앱에서만 사용해야 됨. 그렇지 않으면 기존 download된 콘텐츠는 볼 수 없음
    startStorage 함수를 호출 전에 사용해야 됨. default path로 Documnet 폴더를 사용

  • (BOOL) startStorage: (NSError **) error
    KollusStorage 시작

    매개변수설명
    error에러 상세
    반환값설명
    YES성공
    NO실패

    ⚠️ 주의

    이 메서드를 호출하지 않은 경우 콘텐츠 정보 배열(contents)이 nil로 반환됨

  • (BOOL) startStorageWithCheck: (NSError **) error
    KollusStorage 시작

    매개변수설명
    error에러 상세
    반환값설명
    YES성공
    NO실패

    ⚠️ 주의

    이 메서드를 호출하지 않은 경우 콘텐츠 개수(contentsCount)가 0으로 반환됨
    이 메서드는 키체인으로부터 플레이어 ID 획득 실패 시 최초 실행이면 새로 생성후 처리, 최초 실행이 아니면 세번 요청 모두 실패시 에러 처리

  • (BOOL) startStorageWithFirst: (BOOL) first error: (NSError **) error
    KollusStorage 시작

    매개변수설명
    first설치 후 최초 실행
    error에러 상세
    반환값설명
    YES성공
    NO실패

    ⚠️ 주의

    이 메서드를 호출하지 않은 경우 콘텐츠 개수(contentsCount)가 0으로 반환됨

  • (BOOL) startStorageWithNewPlayerID: (NSError **) error
    KollusStorage 시작

    매개변수설명
    error에러 상세
    반환값설명
    YES성공
    NO실패

    ⚠️ 주의

    이 메서드를 호출하지 않은 경우 콘텐츠 개수(contentsCount)가 0으로 반환됨
    이 메서드는 플레이어 ID를 새로 생성하여 키체인에 등록하고 사용

  • (void) updateDownloadDRMInfo: (BOOL) bAll
    DRM 콘텐츠 리스트 갱신

    매개변수설명
    expired모든 콘텐츠 YES, 만기된 콘텐츠 NO

속성 문서화

속성설명
(NSString*) applicationBundleID[read], [write], [nonatomic], [copy]애플리케이션 Bundle ID(ex:com.yourcompany.applicationname)
(NSString*) applicationDeviceID[read], [nonatomic], [copy]Kollus 플레이어 디바이스 ID
(NSDate*) applicationExpireDate[read], [write], [nonatomic], [copy]Kollus SDK 유효 날짜(카테노이드에서 발급)
(NSString*) storagePath[readonly], [nonatomic], [copy]Kollus SDK 폴더
(NSString*) applicationKey[read], [write], [nonatomic], [copy]Kollus SDK 인증 키(카테노이드에서 발급)
(NSString*) applicationVersion[read], [nonatomic], [copy]Kollus SDK 버전
(NSString*) appUserAgent[read], [nonatomic], [copy]UserAgent.
(long long) cacheDataSize[read], [nonatomic], [unsafe_unretained]캐시데이터 총 사이즈(bytes)
(id<KollusStorageDelegate>) delegate[read], [write], [nonatomic], [weak]다운로드 상태정보 델리게이트
(NSString*) deviceType[read], [nonatomic], [copy]디바이스 Type(kp-mobile, kp-tablet)
(NSString*) extraDrmParam[read], [write], [nonatomic], [copy]동적 DRM 파라메터
(NSString*) keychainGroup[read], [write], [nonatomic], [copy]키체인 그룹(ex:com.yourcompany.shared)
(NSInteger) serverPort[read], [write], [nonatomic], [assign]하이브리드 앱에서 사용되는 port 번호
(long long) storageSize[read], [nonatomic], [unsafe_unretained]다운로드 콘텐츠 총 사이즈(bytes)

KollusStorageDelegate 프로토콜

#import <KollusStorageDelegate.h>

인스턴스 메서드

  • (void) - kollusStorage:downloadContent:error:
  • (void) - kollusStorage:request:json:error:
  • (void) - kollusStorage:cur:count:error:
  • (void) - kollusStorage:lmsData:resultJson:
  • (void) - onSendCompleteStoredLms:failCount:

메서드 문서화

  • (void) kollusStorage: (KollusStorage *) kollusStorage cur: (int) cur count: (int) count error: (NSError *) error
    DRM 콘텐츠 리스트를 일괄 갱신중 각 콘텐츠 갱신이 끝난 경우 호출

    매개변수설명
    KollusStorageKollusStorage ID
    cur현재 항목
    count전체 콘텐츠 개수
    error에러 정보: nil이 아닌 경우 에러 발생

  • (void) kollusStorage: (KollusStorage *) kollusStorage downloadContent: (KollusContent *) content error: (NSError *) error
    콘텐츠 다운로드 중 상태 변화가 있는 경우 호출

    매개변수설명
    KollusStorageKollusStorage ID
    content상태 변화가 있는 콘텐츠 정보
    error에러 정보: nil이 아닌 경우 에러 발생

  • (void) kollusStorage: (KollusStorage *) kollusStorage lmsData: (NSString *) lmsData resultJson: (NSDictionary *) resultJsonLMS
    콜백 처리 후 호출

    매개변수설명
    kollusStorageKollusStorage ID
    lmsDataLMS data 정보
    resultJsonLMS result 정보

  • (void) kollusStorage: (KollusStorage *) kollusStorage request: (NSDictionary *) request json: (NSDictionary *) json error: (NSError *) error
    DRM 다운로드 콜백 처리 후 호출

    매개변수설명
    KollusStorageKollusStorage ID
    requestrequest 정보
    jsonresponse 받은 json
    error에러 정보: nil이 아닌 경우 에러 발생

  • (void) onSendCompleteStoredLms: (int) successCount failCount: (int) failCount
    미전송 LMS 콜백 완료 후 호출

    매개변수설명
    successCountLMS 전송 성공 횟수
    failCoundLMS 전송 실패 횟수


KPSection 클래스

#import <KPSection.h>

속성

속성설명
NSInteger startTimePlay Section Start Time.
NSInteger endTimePlay Section End Time.

속성 문서화

속성설명
(NSInteger) endTime[read], [write], [nonatomic], [unsafe_unretained]Play Section End Time.
(NSInteger) startTime[read], [write], [nonatomic], [unsafe_unretained]Play Section Start Time.

LogUtil 클래스

#import <LogUtil.h>

클래스 메서드

  • (instancetype) - sharedUtil
  • (void) - utilLog:

속성

  • id<UtilDelegate> utilDelegate

메서드 문서화

  • (instancetype) sharedUtil
  • (void) utilLog: (NSString *) logContent , ...

속성 문서화

  • (id<UtilDelegate>) utilDelegate[read], [write], [nonatomic], [weak]

SubTitleInfo 클래스

#import <SubTitleInfo.h>

속성

속성설명
NSString * strName자막 이름
NSString * strUrl자막 경로
NSString * strLanguage자막 언어
BOOL isAISubtitlesAI 자막 여부

상세한 설명

자막 정보

속성 문서화

속성설명
(NSString*) strLanguage[read], [nonatomic], [retain]자막 언어
(NSString*) strName[read], [nonatomic], [retain]자막 이름
(NSString*) strUrl[read],[nonatomic], [retain]자막 경로
BOOL isAISubtitls[read], [nonatomic], [unsafe_unretained]AI 자막 여부

UtilDelegate 프로토콜

#import <LogUtil.h>

인스턴스 메서드

  • (void) - onLogUtil:

메서드 문서화

  • (void) onLogUtil: (NSString *) logData