iOS API References


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 * DRMCheckDate

DRM 체크일시

NSDate * DRMExpireDate

DRM 만료일시

long DRMExpireCountMax

DRM 최대 카운트

long DRMExpireCount

DRM 재생 카운트

NSTimeInterval DRMTotalExpirePlayTime

DRM 전체 재생가능 시간

NSTimeInterval DRMExpirePlayTime

DRM 재생가능 시간

BOOL DRMExpired

DRM 만료여부

BOOL DRMExpireRefreshPopup

DRM 유효기간 갱신 팝업 여부

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]

플레이어 타입 : 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 *)  bookmarksenabled: (BOOL)  enabled error: (NSError *)  error

재생 컨텐트의 북마크 유무를 호출

매개변수:

kollusPlayerView

KollusPlayerView 아이디

bookmarks

KollusBookmark 배열

enabled

YES: 북마크 있음 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 값 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

bitragte

정보

 

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView buffering: (BOOL)  buffering prepared: (BOOL)  prepared error: (NSError *)  error

시스템의 데이터 버퍼링이 정체되거나 정체가 해소된 경우에 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

buffering

YES 버퍼링 시작

buffering

NO 버퍼링 완료

prepared

NO 재생 준비전

prepared

YES 재생 준비후

error

에러상세

Remarks:

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

 

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charset: (char *)  charset caption: (char *)  caption

컨텐츠의 자막 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

charset

캐릭터셋

caption

출력될 자막 데이터

 

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charsetSub: (char *)  charsetSubcaptionSub: (char *)  captionSub

컨텐츠의 서브자막 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

charsetSub

캐릭터셋

captionSub

출력될 자막 데이터

 

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView enabledOutput: (BOOL)  enabledOutputerror: (NSError *)  error

TV출력 허용 컨텐트 속성 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

enabledOutput

YES TV출력 허용

enabledOutput

NO TV출력 허용안함

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView framerate: (int)  framerate

컨텐츠의 프레임레이트 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

framerate

영상 프레임레이트

 

  • (void) kollusPlayerView: (KollusPlayerView *) view height: (int)  height

HLS 컨텐츠 재생중인 resolution 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

video

height 정보

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView lockedPlayer: (KollusPlayerType)  playerType

디바이스  발생시 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

lockedPlayer

실행중인 player type

 

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView mck: (NSString *)  mck

미디어 컨텐츠 키를 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

미디어

컨텐츠 키

 

  • (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView naturalSize: (CGSize)  naturalSize

컨텐츠의 원본 영상사이즈 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

contentResolution

영상사이즈

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView pause: (BOOL)  userInteraction error: (NSError *)  error

일시정지  경우에 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

userInteraction

YES 사용자가 일시정지

userInteraction

NO 시스템이 일시정지

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView play: (BOOL)  userInteraction error: (NSError *)  error

재생이 시작된 경우에 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

userInteraction

YES 사용자가 시작

userInteraction

NO 전제 반복을 통해서 시작, 시스템이 시작

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView playbackRate: (float)  playbackRate error: (NSError *)  error

재생속도가 변경되었음

매개변수:

kollusPlayerView

KollusPlayerView 아이디

playbackRate

변경된 재생속도

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView playerContentFrame: (CGRect)  contentFrame error: (NSError *)  error

재생화면 사이즈가 변경되었음

매개변수:

kollusPlayerView

KollusPlayerView 아이디

contentFrame

변경된 화면 사이즈 정보

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView playerContentMode: (KollusPlayerContentMode)  playerContentMode error: (NSError *)  error

재생화면 모드가 변경되었음

매개변수:

kollusPlayerView

KollusPlayerView 아이디

playerContentMode

변경된 재생화면 모드

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView position: (NSTimeInterval)  position error: (NSError *)  error

재생위치가 변경되기 전후에 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

position

변경되는 재생시간 값

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView prepareToPlayWithError: (NSError *)  errorprepareToPlay 

호출  컨텐트 재생준비 완료여부를 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

error

에러상세

Remarks:

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

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView repeat: (BOOL)  repeat error: (NSError *)  error

반복재생모드가 변경되었음

매개변수:

kollusPlayerView

KollusPlayerView 아이디

repeat

YES 반복재생 설정모드로 변경

repeat

NO 반복재생 해제모드로 변경

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView scroll: (CGPoint)  distance error: (NSError *)  error

영상화면 이동 동작 전후에 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

distance

영상 이동 거리

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView stop: (BOOL)  userInteraction error: (NSError *)  error

재생이 정지된 경우에 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

userInteraction

YES 사용자가 종료

userInteraction

NO 끝까지 재생되어 종료, 시스템이 종료

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView thumbnail: (BOOL)  isThumbnail error: (NSError *)  error

썸네일 비동기 다운로드 완료를 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

썸네일

유무

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView unknownError: (NSError *)  error

기타에러 발생시 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

error

에러상세

 

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView zoom: (UIPinchGestureRecognizer *)  recognizer error: (NSError **)  error

비디오 출력화면 확대/축소 전후에 전송

매개변수:

kollusPlayerView

KollusPlayerView 아이디

recognizer

pinch줌을 적용할 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 전송 후 호출

매개변수:

kollusPlayerView

KollusPlayerView 아이디

json

레스폰스 받은 JSON 객체

error

에러상세


 

<KollusPlayerLMSDelegate> 프로토콜 참조

 

#import <KollusPlayerLMSDelegate.h>

인스턴스 메소드들

(void) - kollusPlayerView:json:error:

 

메소드 문서화

  • (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView json: (NSDictionary *)  json error: (NSError *)  error

LMS정보를 서버로 전송후 호출

매개변수:

kollusPlayerView

KollusPlayerView 아이디

json

리퀘스트로 보낸 JSON 객체

error

네트워크 에러(nil: 성공)


 

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 > DRMDelegate

DRM 정보 관련 델리게이트

id< KollusPlayerLMSDelegate > LMSDelegate

LMS정보 관련 델리게이트

id< KollusPlayerBookmarkDelegate > bookmarkDelegate

Bookmark 관련 델리게이트

KollusStorage * storage

KollusStorage 포인터

NSString * contentURL

재생할 컨텐트 URL(Stream Play)

NSString * mediaContentKey

재생할 컨텐트 Media Content Key (Local Play)

KollusContent * content

사용중인 컨텐츠 정보

BOOL AIRateEnable

AI 배속 지원 여부

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 isWaterMark

Audio water mark 여부

BOOL isAudioOnly

오디오 컨텐트 여부

BOOL muteOnStart

시작시 mute 여부

CGSize naturalSize

원본컨텐츠 영상사이즈

BOOL isZoomedIn

Zoom in 여부

KollusPlayerType playerType

플레이어 타입

NSString * customSkin

플레이어 스킨정보 JSON Data

KPSection * playSection

미리보기 정보

NSInteger nRepeatStartTime

Repeat Start Time.

NSInteger nRepeatEndTime

Repeat End Time.

BOOL audioBackgroundPlay

백그라운드 오디오파일 재생

BOOL lmsOffDownloadContent

다운로드 컨텐츠 lms off

NSUInteger proxyPort

Proxy Server Port 지정

BOOL intro

인트로 여부

BOOL seekable

seek   있는지

NSInteger nSecSkip

주어진 n초후에 skip

BOOL isLive

Live 여부

BOOL disablePlayRate

배속 컨트롤 가능 여부

NSInteger nSeekableEnd

NSString * strCaptionStyle

Partner portal 설정  : 자막 스타일 "bg" : 자막 배경 적용, "bg" 아니면 사용자 설정

BOOL forceNScreen

강제 이어보기

BOOL ignoreZero

이어보기 시간 값이 작을 때에도 이어보기 유효

BOOL isThumbnailEnable

썸네일 사용 여부

BOOL isThumbnailSync

썸네일 다운로드 방식(sync, async)

NSString * fpsCertURL

FairPlay 인증 URL.

NSString * fpsDrmURL

FairPlay DRM URL.

NSInteger nOfflineBookmarkUse

NSInteger nOfflineBookmarkDownload

1: 인덱스만 다운로드, 2: 인덱스/북마크 모두 다운로드

NSInteger nOfflineBookmarkReadOnly

추가/삭제 사용 여부( 0:사용(기본값), 1: 사용 안함)

NSString * strVideoWaterMark

NSInteger nVideoWaterMarkAlpha

비디오 워터마크 알파 

NSInteger nVideoWaterMarkFontSize

비디오 워터마크 폰트 크기

NSString * strVideoWaterMarkFontColor

비디오 워터마크 칼라

NSInteger nVideoWaterMarkShowTime

비디오 워터마크 보이는 시간

NSInteger nVideoWaterMarkHideTime

비디오 워터마크 보이지 않는 시간

NSString * extraDrmParam

동적 drm 파라메터

NSMutableArray * streamInfoList

HLS ABR Information.

KollusChat * kollusChat

라이브 채팅

NSInteger nextEpisodeShowTime

다음 회차 재생 Show Time

NSString * nextEpisodeCallbackURL

다음 회차 재생 URL

NSMutableDictionary * nextEpisodeCallbackParams

다음 회차 재생 Params

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

비디오 영역

반환값:

CGRect 비디오 재생 위치

 

  • (CGFloat) getZoomValue

비디오 출력화면 확대/축소 값

반환값:

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

 

  • (id) initWithContentURL: (NSString *)  url

컨텐트URL을 사용하여 플레이어를 생성

매개변수:

url

재생할 컨텐트 URL

반환값:

생성된 플레이어 아이디

 

  • (id) initWithMediaContentKey: (NSString *)  mck

컨텐트 인덱스를 사용하여 플레이어를 생성(다운로드 받은 컨텐트의 경우에 사용)

매개변수:

mck

재생할 컨텐트의 mediaContentKey

반환값:

생성된 플레이어 아이디

 

  • (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

컨텐츠 재생준비 (KollusPlayer or Native)

매개변수:

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

YES

zoom out 기능 Disable

 

  • (void) setNetworkTimeOut: (NSInteger)  timeOut

플레이어 네트워크 타임아웃 설정

매개변수:

timeOut

타임아웃 값(초)

retryCount

재시도 횟수

 

  • (void) setPauseOnForeground: (BOOL)  bPause

Foreground 상태로 변경시 Player 재생상태를 Pause 유지하기 위한 API

매개변수:

NO(default)

포그라운드 진입시 자동재생(기존과 동일)

YES

포그라운드 진입시 pause 상태로 유지됨. APP에서 필요한 경우 Play 처리 필요

 

  • (BOOL) setSkipPlay 

play list중에 현재 재생중인 동영상을 skip

 

  • (bool) setSubTitlePath: (char *)  path

자막파일 선택

매개변수:

path

사용할 자막파일 경로

반환값:

bool true:성공 false:실패

 

  • (bool) setSubTitleSubPath: (char *)  path

서브자막파일 선택

매개변수:

path

사용할 자막파일 경로

반환값:

bool true:성공 false:실패

 

  • (BOOL) stopWithError: (NSError **)  error

재생중지

매개변수:

error

에러상세

반환값:

YES 성공

NO 실패

경고:

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

 

  • (BOOL) zoom: (UIPinchGestureRecognizer *)  recognizer error: (NSError **)  error

비디오 출력화면 확대/축소

매개변수:

recognizer

pinch줌을 적용할 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) isWaterMark[read], [nonatomic], [unsafe_unretained]

Audio water mark 여부

  • (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]

재생할 컨텐트 Media Content Key (Local Play)

  • (BOOL) muteOnStart[read], [nonatomic], [unsafe_unretained]

시작시 mute 여부

  • (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

  • (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) - 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 * applicationVersion

KollusSDK 버전

NSString * applicationDeviceID

KollusPlayer Device ID.

NSString * applicationKey

KollusSDK 인증 (카테노이드에서 발급)

NSString * applicationBundleID

어플리케이션 Bundle ID(ex:com.yourcompany.applicationname)

NSString * keychainGroup

keychain 그룹(ex:com.yourcompany.shared)

NSDate * applicationExpireDate

KollusSDK 유효날짜(카테노이드에서 발급)

long long storageSize

다운로드 컨텐츠  사이즈(bytes)

long long cacheDataSize

캐시데이터  사이즈(bytes)

NSInteger serverPort

Hybrid App에서 사용되는 port 번호

NSString * extraDrmParam

동적 drm 파라메터

NSString * appUserAgent

UserAgent.

NSString * deviceType

디바이스 Type(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

삭제할 컨텐트 키

error

에러상세

반환값:

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) startStorage: (NSError **)  error

KollusStorage 시작

매개변수:

error

에러

반환값:

YES 성공

NO 실패

경고:

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

 

  • (BOOL) startStorageWithCheck: (NSError **)  error

KollusStorage 시작

매개변수:

error

에러

반환값:

성공시 YES, 실패 시 NO를 반환

경고:

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

이 메서드는 키체인으로부터 playerID 획득 실패시 최초 실행이면 새로 생성후 처리, 최초 실행이 아니면 세번 요청 모두 실패시 에러 처리

 

  • (BOOL) startStorageWithFirst: (BOOL)  first error: (NSError **)  error

KollusStorage 시작

매개변수:

first

설치후 최초 실행

error

에러

반환값:

성공시 YES, 실패 시 NO를 반환

경고:

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

 

  • (BOOL) startStorageWithNewPlayerID: (NSError **)  error

KollusStorage 시작

매개변수:

error

에러

반환값:

성공시 YES, 실패 시 NO를 반환

경고:

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

이 메서드는 playerID를 새로 생성하여 키체인에 등록하고 사용

 

  • (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]

KollusPlayer Device ID.

  • (NSDate*) applicationExpireDate[read], [write], [nonatomic], [copy]

KollusSDK 유효날짜(카테노이드에서 발급)

  • (NSString*) applicationKey[read], [write], [nonatomic], [copy]

KollusSDK 인증 키(카테노이드에서 발급)

  • (NSString*) applicationVersion[read], [nonatomic], [copy]

KollusSDK 버전

  • (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]

keychain 그룹(ex:com.yourcompany.shared)

  • (NSInteger) serverPort[read], [write], [nonatomic], [assign]

Hybrid App에서 사용되는 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 컨텐츠 리스트를 일괄 갱신중 각 컨텐츠 갱신이 끝난 경우 호출

매개변수:

KollusStorage

KollusStorage 아이디

cur

현재 항목

count

전체 컨텐츠 갯수

error

에러정보: nil이 아닌 경우 에러발생

 

  • (void) kollusStorage: (KollusStorage *)  kollusStorage downloadContent: (KollusContent *)  content error: (NSError *)  error

컨텐트 다운로드  상태변화가 있는 경우 호출

매개변수:

KollusStorage

KollusStorage 아이디

cotent

상태변화가 있는 컨텐트 정보

error

에러정보: nil이 아닌 경우 에러발생

 

  • (void) kollusStorage: (KollusStorage *)  kollusStorage lmsData: (NSString *)  lmsData resultJson: (NSDictionary *)  resultJsonLMS 

Callback 처리후 호출

매개변수:

KollusStorage

KollusStorage 아이디

lmsData

lms data 정보

lmsResult

lms result 정보

 

  • (void) kollusStorage: (KollusStorage *)  kollusStorage request: (NSDictionary *)  request json: (NSDictionary *)  json error: (NSError *)  error

DRM Callback 처리후 호출

매개변수:

KollusStorage

KollusStorage 아이디

request

request 정보

json

response 받은 json

error

에러정보: nil이 아닌 경우 에러발생

 

  • (void) onSendCompleteStoredLms: (int)  successCount failCount: (int)  failCount

미전송 LMS Callback 완료후 호출

매개변수:

successCount

lms 전송 성공 횟수

failCount

lms 전송 실패 횟수


KPSection 클래스 참조

 

#import <KPSection.h>

 

속성

NSInteger startTime

Play Section Start Time.

NSInteger endTime

Play 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

자막 언어

 

상세한 설명

자막 정보

 

속성 문서화

  • (NSString*) strLanguage[read], [write], [nonatomic], [retain]

자막 언어

  • (NSString*) strName[read], [write], [nonatomic], [retain]

자막 이름

  • (NSString*) strUrl[read], [write], [nonatomic], [retain]

자막 경로


<UtilDelegate> 프로토콜 참조

 

#import <LogUtil.h>

 

인스턴스 메소드들

(void) - onLogUtil:

 

메소드 문서화

  • (void) onLogUtil: (NSString *)  logData

Copyright © CATENOID, lnc. All Rights Reserved.
E-mail. support@catenoid.net | Tel. 1544-4367