Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3

Kollus Mobile Player SDK

Hybrid Player

웹 인터페이스

사용법

제어 스크립트를 html의 적당한 위치에 삽입합니다.

구현에 필요한 모든 문자열은 UTF-8 인코딩 합니다.

Code Block
languagejs
themeMidnight
<script src=”kollus.mobile.min.js”></script>

제어 스크립트 API Reference

메소드설명파라미터
version스크립트의 현재 버전을 돌려준다.
start동영상 플레이어를 화면에 시작합니다-(string) media_url: 동영상 재생 주소
-(object) options: 동영상 재생 옵션
-(object) position: 동영상 재생위치.
left, top 위치에서 width, height 사이즈로 재생.
-(int) left
-(int) top
-(int) width
-(int) height
-(int) marginTop
stop화면에 나타난 동영상 플레이어를 종료합니다.없음
show동영상 플레이어를 화면에 표시하며, pause 상태인 경우, 멈춘 위치부터 재생을 시작합니다.없음
hide동영상 플레이어를 화면에서 숨깁니다.없음
fullscreen동영상을 전체 화면 모드로 바꿉니다.없음
download_home다운로드 홈 화면 표시없음
download선택한 폴더에 선택한 url의 컨텐츠를 다운로드(array)
(string) folder
(string) url
remove_contents다운로드 컨텐츠를 모두 삭제없음
download_list다운로드 리스트를 JSON으로 받음없음
content_info다운로드한 컨텐츠 정보를 JSON으로 받음media_content_key
player_info플레이어 정보를 JSON으로 받음없음
bind특정 이벤트명으로 콜백 함수 설정(string) event_name : 이벤트 명
(function) callback : 콜백 함수
unbind이벤트명에 설정된 콜백 함수 전부 제거(string) event_name : 이벤트 명

제어 스크립트 샘플

version

동영상 플레이어의 현재 버전을 가져옵니다.

정의
Code Block
string version;

사용 예
Code Block
var ver = window.KollusMobile.version;

start

동영상 플레이어를 화면에 시작하기 위해 호출합니다.

정의
Code Block
void start(string media_url, ojbect option);

Param
  • media_url
    • 기본 값 : 없음. (string)
    • 동영상 재생에 필요한 URI
  • option
    • 기본 값 : 없음 (object)
    • 플레이어 옵션
추가 옵션 (Option)
  • position
    • 기본 값 : left(0), top(0), width(640), height(480), marginTop(0), (int)
    • 동영상이 표시될 위치를 지정합니다.
    • left, top, width, height, marginTop
Option 샘플
Code Block
{
    player: {
	media_url: '',
	options: {
	    position: {
		left: 0,
		top: 0,
		width: 0,
		height: 0,
		marginTop: 0
	   }
	}
    }
};

사용 예
Code Block
window.KollusMobile.start({
	media_url: 'http://v.kr.kollus.com/sr?key=D9C34B...062BA9F06|V1.0',
	options: {
	    position: {
		"left": 0,
		"top": 0,
		"width": 640,
		"height": 480,
		"marginTop": 0
	   }
	}
});

stop

화면에 표시된 동영상 플레이어를 종료합니다.

정의
Code Block
void stop();

사용 예
Code Block
window.KollusMobile.stop();

show

화면에서 숨겨졌던 동영상 플레이어를 다시 화면에 보이게 합니다.

정의
Code Block
void show();


사용 예

Code Block
window.KollusMobile.show();


hide

화면에 표시된 동영상 플레이어를 숨깁니다.

정의
Code Block
void hide();


사용 예

Code Block
window.KollusMobile.hide();


download_home

다운로드 홈을 화면에 표시합니다.

정의
void download_home();
사용 예
window.KollusMobile.hide();

download

동영상 다운로드를 위해 호출합니다

정의
void download(ojbect option);
파라미터 (Params)
  • option
    • 기본 값 : 없음 (object)
    • 다운로드 옵션
    • folder : 다운로드를 하고자 하는 위치
      • 없으면 루트에 다운로드 합니다
    • url : 다운로드할 동영상의 URL
Params 샘플
[
    {
        “folder”:”수학”,
        “url”:”http://v.kr.kollus.com/i/abcdef”
    },
    {
        “folder”:”영어”,
        “url”:”http://v.kr.kollus.com/i/abcdef”
    },
    {
        “url”:”http://v.kr.kollus.com/i/abcdef”
    }
]
사용 예
window.KollusMobile.download(
	[
                {
                    “folder”:”수학”,
                    “url”:”http://v.kr.kollus.com/i/abcdef”
                },
                {
                “folder”:”영어”,
                “url”:”http://v.kr.kollus.com/i/abcdef”
            },
            {
                “url”:”http://v.kr.kollus.com/i/abcdef”
            }
        ]);

remove_contents

다운로드 컨텐츠를 모두 삭제합니다.

작업 완료 후 같은 이름의 이벤트가 Callback 호출 됩니다

정의
void remove_contents();
사용 예
window.KollusMobile.bind(“remove_contents”, function(){
  console.log(“remove_contents completed”);
});

window.KollusMobile.remove_contents();

download_list

다운로드 리스트를 object 형식으로 콜백 수신 됩니다.

파라미터는 없습니다.

정의
void download_list();
사용 예
window.KollusMobile.bind(“download_list”, function(data){
  var json = $.parseJSON(data);
});

window.KollusMobile.download_list();

반환되는 컨텐츠 정보

  • title
    • 컨텐츠 제목
  • media_key
    • 컨텐츠 미디어 키
  • play_at
    • nscreen 정보
  • duration
    • 컨텐츠 재생 시간
  • file_size
    • 컨텐츠 파일 용량
  • is_complete
    • 컨텐츠 다운로드 완료 여부
  • expire_date
    • 컨텐츠 만료 기한
  • expire_count
    • 컨텐츠의 남은 재생 가능 회수
  • total_expire_count
    • 컨텐츠의 부여 받은 재생 가능 회수
  • expire_playtime
    • 컨텐츠의 남은 재생 가능 시간(초)
  • total_expire_playtime
    • 컨텐츠의 부여 받은 재생 가능 시간(초)
  • is_expired
    • 컨텐츠의 만료 여부
  • snapshot_path
    • 컨텐츠 스냅샷 이미지의 절대경로

content_info

다운로드한 컨텐츠 정보를 object 형식으로 콜백 수신 됩니다.

정의
void content_info(string media_content_key);
파라미터 (Params)
  • media_content_key
    • 기본 값 : 없음. (string)
    • 정보를 가져올 컨텐츠의 미디어 컨텐츠 키
사용 예
window.KollusMobile.bind(“content_info”, function(data){
  var json = $.parseJSON(data);
});

window.KollusMobile.content_info('abcdef');

player_info

플레이어 정보를 object 형식으로 콜백 수신 됩니다.

파라미터는 없습니다

정의
void player_info();
사용 예
window.KollusMobile.bind(“player_info”, function(data){
  var json = $.parseJSON(data);
});

window.KollusMobile.player_info();
반환되는 플레이어 정보
항목속성자료형AndroidiOS
generalnotify_3gboolOO

is_nscreenboolOO

is_prefer_sw_codecboolOX

is_native_playerboolXO

disable_manner_modeboolXO
subtitlesizeint32OO

colorint32OO

is_strokeboolOX

stroke_colorint32OX
storagedownloadint64OO

cacheint64OO

etcint64OO

freeint64OO
playerversionstringOO

idstringOO
  • general
    • notify_3g
      • 3G/LTE 연결하여 데이터 이용 시도 시 팝업창 띄울 지 여부
    • is_nscreen
      • 이어보기 정보가 있을 때 이어보기 팝업창 띄울 지 여부
    • is_prefer_sw_codec
      • 소프트웨어 코덱으로 재생 시도할 지 여부
    • is_native_player
      • 내장 플레이어 사용 여부
    • disable_manner_mode
      • 매너모드인 경우 사운드 강제 출력 여부
  • subtitle
    • size
      • 자막 크기
    • color
      • 자막 색상
    • is_stroke
      • 자막 테두리 여부
    • stroke_color
      • 자막 테두리 색상
  • storage
    • download
      • 다운로드 컨텐츠의 총 용량
    • cache
      • 스트리밍용에서 사용하고 있는 용량
    • etc
      • 앱 이외에서 사용하고 있는 용량
    • free
      • 스토리지에 남아 있는 용량
  • player
    • version
      • 앱 버전
    • id
      • 플레이어 ID

bind

show 호출시 지정한 action이나 화면 전환등 앱에서 이벤트하면 호출됩니다.

(#앱의 특성상 동일한 이벤트가 한 번 이상 반복해서 발생할 수 있습니다.)

정의
void bind(string event_name, function callback);
이벤트 종류 (event_name)
  1. back

    • 세로 보기 모드로 전환되는 경우

    • 이전 버튼을 누른 경우

  2. error

    • 에러가 발생한 경우
    • 에러코드
  3. download_list

    • download_list()를 호출한 경우
  4. content_info

    • content_info()를 호출한 경우
  5. player_info

    • player_info()를 호출한 경우
  6. remove_contents

    • remove_contents()를 호출한 경우
  7. 플레이어 기본 액션 실행시

    • start, stop, show, hide, fullscreen, popup
사용 예
window.KollusMobile.bind('back', function(data) {
		console.log('[back]', data);
	});
window.KollusMobile.bind('error', function(error) {
		console.log('[error]', error);
	});
window.KollusMobile.bind('download_list', function(data) {
		console.log('[download_list] ', data);
	});
window.KollusMobile.bind('content_info', function(data) {
		console.log('[content_info] ', data);
	});
window.KollusMobile.bind('player_info', function(data) {
		console.log('[player_info] ', data);
	});

웹 샘플 페이지

샘플 프로그램은 별도 문서로 제공됩니다. (담당자에게 문의해주십시오.)

에러코드

에러코드설명
0알수 없는 오류

Android App 설명

Android향 앱 지원 모듈 설명입니다

OS 지원범위

  • ICS(API Level 14) 이상부터 지원 안드로이드 SDK v14을 기준으로 개발 및 테스트 되었습니다.

테스트 단말 정보

  • Nexus 6P

iOS App 설명

iPhone, iPad향 앱 지원 모듈 설명입니다.

OS 지원범위

  • iOS 8.0 이상 XCode 컴파일시 지원 OS 설정을 iOS 8.0 이상을 타켓으로 개발 및 테스트 되었습니다.

테스트 단말 정보

  • iPhone 5 (8.3)
  • iPhone 6 plus (10.1.1)
  • iPad mini (9.3.5)