| Expand | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
API 문서 정보
버전 : 3.0.12
날짜 : 2024. 911. 117
com.kollus.sdk.media.MediaPlayer.APP_STATUS 인터페이스 참조
...
KollusContent ()
KollusContent (Parcel in)
void setForPlay (Parcel in)
void setForDownload (Parcel in)
void setByJson (String jsonString)
void copy (KollusContent content)
boolean isSection ()
String getMediaContentKeyMD5 ()
void setMediaContentKey (String key)
String getMediaContentKey ()
String getUploadFileKey ()
void setContentType (ContentType type)
ContentType getContentType ()
String getLicenseUrl ()
String getLicenseKey ()
String getLicenseToken ()
String getCompany ()
String getThumbnailPath ()
String getOriginThumbnailPath ()
String getScreenShotPath ()
String getAiScriptPath ()
String getCourse ()
String getSubCourse ()
String getTeacher ()
String getSynopsis ()
String getDetailInfoUrl ()
int getUriIndex ()
void setUriIndex (int index)
void setPlaytime (int playtime)
int getPlaytime ()
int getStartAt ()
int getDuration ()
void setReceivedSize (long receiveSize)
long getReceivedSize ()
void setReceivingSize (long receiveSize)
long getReceivingSize ()
void setFileSize (long fileSize)
long getFileSize ()
boolean IsInvalidFileSize ()
String getMediaUrl ()
void setLocalMediaUrl (String mediaUrl)
String getLocalMediaUrl ()
int getPlaySectionStart ()
int getPlaySectionEnd ()
int getRepeatPlaySectionStart ()
int getRepeatPlaySectionEnd ()
boolean getDisablePlayRate ()
int getSeekableEnd ()
String getCaptionStyle ()
boolean isVmCheck ()
void setDownloadPercent (int percent)
int getDownloadPercent ()
void setDownloadCompleted (boolean complete)
boolean isCompleted ()
void setDownloadError (boolean bError)
boolean getDownloadError ()
void setLoaded (boolean bLoaded)
boolean isLoaded ()
String getNextEpisodeCallbackUrl ()
String getNextEpisodeCallbackData ()
int getNextEpisodeShowTime ()
boolean getForceNScreen ()
int getMaxPlaybackRate ()
boolean useBlockEmulator ()
boolean isIgnoreZero ()
boolean getMute ()
boolean getDisableTvOut ()
boolean isAudioFile ()
boolean isIntro ()
boolean getSeekable ()
int getSkipSec ()
String getAudioWaterMark ()
String getForensicWaterMark ()
boolean hasAudioWaterMark ()
boolean hasForensicWaterMark ()
boolean isThumbnailEnable ()
boolean isThumbnailDownloadSync ()
String getVideoWaterMarkCode ()
int getVideoWaterMarkAlpha ()
int getVideoWaterMarkFontSize ()
int getVideoWaterMarkFontColor ()
int getVideoWaterMarkShowTime ()
int getVideoWaterMarkHideTime ()
int getVideoWaterMarkSpace ()
boolean isVideoWaterMarkRandom ()
boolean isLive ()
boolean isVr ()
int getExpirationDate ()
int getTotalExpirationCount ()
int getExpirationCount ()
int getTotalExpirationPlaytime ()
int getExpirationPlaytime ()
boolean getExpirationRefreshPopup ()
void setContentExpired (boolean expired)
boolean isContentExpirated ()
int getVideoWidth ()
int getVideoHeight ()
int getBitrate ()
boolean isDrm ()
void setDownloading (boolean downloading)
boolean isDownloading ()
void setDownloadCanceled ()
boolean isDownloadCanceled ()
String getSkinString ()
ChattingInfo getChattingInfo ()
Vector< SubtitleInfo > getSubtitleInfo ()
Vector< SubtitleInfo > getSubtitleSubInfo ()
String getServiceProviderMessage ()
void setServiceProviderMessage (String message)
String toString ()
...
다운로드 컨텐츠에 대해 drm 여부 확인
반환값
drm 여부
boolean com.kollus.sdk.media.content.KollusContent.isIgnoreZero ()
이어보기 정보를 무시할 여부를 가져오는 함수
반환값
true이면 play at이 앞뒤로 일정 시간미만인 경우에도 이어보기 실행
false이면 기존대로 일정 시간미만인 경우 이어보기 하지 않고 처음부터 재생
예) KollusPlayer앱은 이어보기 정보가 앞뒤로 10초미만인 경우 이어보기 하지 않고 처음부터 재생합니다.
boolean com.kollus.sdk.media.content.KollusContent.isIntro ()
인트로 영상인 지 여부를 알 수 있는 함수
반환값
인트로 영상 여부
boolean com.kollus.sdk.media.content.KollusContent.IsInvalidFileSize ()
다운로드가 완료된 컨텐츠의 파일 사이즈 유효성
반환값
true:유효한 파일, false:유효하지 않은 파일
boolean com.kollus.sdk.media.content.KollusContent.isLive ()
라이브 영상 여부를 가져오는 함수
반환값
라이브 영상 여부
boolean com.kollus.sdk.media.content.KollusContent.isLoaded ()
다운로드를 위해 로드를 했는지 여부를 가져오는 함수
반환값
로드 여부
boolean com.kollus.sdk.media.content.KollusContent.isSection ()
사용 안함
반환값
boolean com.kollus.sdk.media.content.KollusContent.isThumbnailDownloadSync ()
load 시 썸네일 다운로드가 Sync(no thread)인지 여부를 가져오는 함수
반환값
true:load시 썸네일 다운로드를 같이 함, false:썸네일 다운로드를 병렬 처리함
boolean com.kollus.sdk.media.content.KollusContent.isThumbnailEnable ()
썸네일 활성화 여부를 가져오는 함수
반환값
썸네일 활성화 여부
boolean com.kollus.sdk.media.content.KollusContent.isVideoWaterMarkRandom ()
비디오 워터마크 표시가 랜덤인지 여부를 가져오는 함수
반환값
랜덤 여부
boolean com.kollus.sdk.media.content.KollusContent.isVmCheck ()
가상머신에서 재생을 허용하는 여부를 가져오는 함수
반환값
true:가상머신에서 재생 허용, false:가상머신에서 재생 허용 안함
boolean com.kollus.sdk.media.content.KollusContent.isVr ()
VR 영상 여부를 가져오는 함수
반환값
VR 영상 여부
void com.kollus.sdk.media.content.KollusContent.setByJson (String jsonString)
...
KollusContent의 내용을 문자화하는 함수
반환값
KollusContent의 내용
boolean com.kollus.sdk.media.content.KollusContent.useBlockEmulator ()
에뮬레이터를 사용하고 있는지 여부를 가져오는 함수
반환값
에뮬레이터 사용 여부
멤버 데이터 문서화
final Parcelable.Creator<KollusContent> com.kollus.sdk.media.content.KollusContent.CREATOR[static]
...
해당 경로로 현재 라이브 방송인 지 체크하는 함수
매개변수
url | 라이브 방송 URL |
반환값
String com.kollus.sdk.media.KollusStorage.checkVersion ()
라이브러리 버전 정보. 더이상 사용하지 않습니다.
반환값
버전
void com.kollus.sdk.media.KollusStorage.clearCache ()
...
mediaContentKey | 미디어 컨텐트 키 |
참고
ErrorCodes
반환값
에러코드
void com.kollus.sdk.media.KollusStorage.finish ()
...
ArrayList< KollusContent > com.kollus.sdk.media.KollusStorage.getDownloadContentList ()
다운로드 컨텐츠 리스트 정보를 가져온다.
반환값
컨텐츠 리스트
KollusContent com.kollus.sdk.media.KollusStorage.getDownloadKollusContent (String path)
해당 패스로 다운로드 컨텐츠 정보를 얻어오는 함수
반환값
컨텐츠 정보
static synchronized KollusStorage com.kollus.sdk.media.KollusStorage.getInstance (Context context)[static]
Singleton 생성자
매개변수
context | App Context |
반환값
KollusStorage 인스턴스
boolean com.kollus.sdk.media.KollusStorage.getKollusContent (KollusContent content, String mediaContentKey) throws IllegalStateException
재생 시에 해당 컨텐츠 정보를 알기 원할 때 사용한다.
반환값
성공적으로 컨텐츠 정보를 가져왔는 지 여부
String com.kollus.sdk.media.KollusStorage.getLastError ()
에러 발생 시 마지막 에러 메세지를 가져온다.
반환값
에러 메세지
String com.kollus.sdk.media.KollusStorage.getMediaInfoJson (Uri uri)[protected]
해당 uri로 미디어 정보를 가져오는 함수로 SDK 내부에서만 사용됩니다.
매개변수
uri | 정보를 가져오는 URI |
반환값
미디어 정보
long com.kollus.sdk.media.KollusStorage.getNativeInstance ()
KollusStorage int형 인스턴스
반환값
String com.kollus.sdk.media.KollusStorage.getRootPath ()
저장하는 위치를 가져온다. setDevice(setDeviceAsync)에서 넣어준 저장위치와 동일합니다.
반환값
저장위치
long com.kollus.sdk.media.KollusStorage.getUsedSize (int type)
...
type | TYPE_CACHE - 스트리밍 재생에 사용된 캐쉬 용량 TYPE_DOWNLOAD - 다운로드된 컨텐츠 총 용량 |
반환값
용량
String com.kollus.sdk.media.KollusStorage.getVersion ()
라이브러리 버전 정보
반환값
버전
int com.kollus.sdk.media.KollusStorage.initialize (String key, String expireDate, String packageName)
...
path | 다운로드할 컨텐츠 경로 |
extraDrmParam | 동적 DRMCallback/PlayCallback 인자 |
참고
ErrorCodes
반환값
에러 값
void com.kollus.sdk.media.KollusStorage.registerKollusPlayerCallbackListener (KollusPlayerCallbackListener listener)
...
mediaContentKey | 미디어 컨텐트 키 |
참고
ErrorCodes
반환값
에러코드
void com.kollus.sdk.media.KollusStorage.sendStoredLMS (StoredLMSListener listener)
...
mediaContentKey | 미디어 컨텐트 키 |
참고
ErrorCodes
반환값
0보다 작으면 에러 아니면 컨텐츠 인덱스
void com.kollus.sdk.media.KollusStorage.unregisterKollusPlayerCallbackListener (KollusPlayerCallbackListener listener)
...
Mpeg-Dash에서 ABR인 경우 현재 다운로드하고 있는 Bandwidth
반환값
현재 다운로드하고 있는 Bandwidth
int com.kollus.sdk.media.MediaPlayer.getCachedDuration ()
...
현재 재생 위치를 밀리초 단위로 가져오는 함수
반환값
현재 재생하고 있는 시간(밀리초)
int com.kollus.sdk.media.MediaPlayer.getDownloadRate ()
Mpeg-Dash에서 다운로드 속도를 가져오는 함수
반환값
다운로드 속도
int com.kollus.sdk.media.MediaPlayer.getDuration ()
현재 재생 중인 컨텐츠의 duration정보를 밀리초 단위로 가져오는 함수
반환값
컨텐츠의 총 시간(밀리초)
String com.kollus.sdk.media.MediaPlayer.getErrorString (int errorCode)
errorCode를 String으로 가져오는 함수이나 의미있는 값을 전달하지는 않는다. *
매개변수
errorCode | 에러 코드 |
반환값
에러 스트링
boolean com.kollus.sdk.media.MediaPlayer.getKollusContent (KollusContent content) throws IllegalStateException
...
content | 컨텐츠 정보를 가져올 인스턴스 |
반환값
true:성공적으로 정보를 가져온 경우, false:실패한 경우
...
이어보기 정보를 가져오는 함수로 N-Screen과 연관된다.
반환값
이어보기 시간(밀리초)
String com.kollus.sdk.media.MediaPlayer.getPlayerName ()
MediaPlayerFactory에서 만들어진 플레이어의 이름을 가져옵니다.
반환값
플레이어 이름
int com.kollus.sdk.media.MediaPlayer.getPlayerType ()
MediaPlayerFactory에서 만들어진 플레이어의 타입을 가져옵니다.
반환값
플레이어 타입(Utils.PLAYER_TYPE_NATIVE, Utils.PLAYER_TYPE_KOLLUS, Utils.PLAYER_TYPE_EXO)
...
String com.kollus.sdk.media.MediaPlayer.getVersion ()
플레이어 버전을 가져오는 함수
반환값
version 플레이어 버전
String com.kollus.sdk.media.MediaPlayer.getVideoCodecName ()
비디오 코덱 이름을 가져오는 함수로 HW코덱 연동을 확인하기 위해 사용
반환값
코덱 이름
int com.kollus.sdk.media.MediaPlayer.getVideoHeight ()
컨텐츠의 height를 가져오는 함수 onPrepared 응답을 받은 후 호출할 수 있다.
반환값
비디오 세로 사이즈
int com.kollus.sdk.media.MediaPlayer.getVideoWidth ()
컨텐츠의 width를 가져오는 함수 onPrepared 응답을 받은 후 호출할 수 있다.
반환값
비디오 가로 사이즈
boolean com.kollus.sdk.media.MediaPlayer.isAiPlaybackRateEnabled ()
AI 배속 여부를 알려주는 함수
반환값
true : AI 배속, false : 일반 배속
boolean com.kollus.sdk.media.MediaPlayer.isLooping ()
현재 반복 재생인지 여부를 가져오는 함수
반환값
true:반복 재생 상태, false:반복 상태 아님
boolean com.kollus.sdk.media.MediaPlayer.isPlaying ()
현재 재생 중인지 여부를 알 수 있는 함수
반환값
true:재생 상태, false: 재생 상태 아님
...
LMS데이터를 보낼 때 앱상태가 background 또는 foreground될 때의 시간도 같이 보내기 위해 앱 상태가 변경되는 시점을 저장하는 함수
매개변수
status | 앱 상태 |
void com.kollus.sdk.media.MediaPlayer.setAudioDelay (int timeMs)
...
기본 버퍼링량의 배수만큼 설정하는 함수로 Utils.PLAYER_TYPE_KOLLUS인 경우에만 사용 가능합니다.
매개변수
ratio |
|
반환값
true:설정 성공, false:설정 실패
void com.kollus.sdk.media.MediaPlayer.setCaptureDetectLister (CaptureDetectLister listener)
...
배속 조정 함수로 (0.5 ~ 10.0)범위내에서 지원합니다. 오디오 워터마크가 있는 경우 최대 1.5배속으로 제한됩니다. 2.0을 넘어가면 화면 drop으로 원활한 시청이 안될 수 있습니다.
매개변수
playing_rate | 설정할 배속 |
반환값
true:배속 설정 성공, false:배속 설정 실패
...
현재 플레이어가 배속 조절을 지원하는 지 여부
반환값
ture:배속 지원, false: 배속 미지원
...
mp | 에러가 발생한 플레이어 |
what | 에러 코드 1 |
extra | 에러 코드 2 |
반환값
UI에서 에러를 처리했는지 여부를 SDK에 전달하는 값으로 False를 리턴하면 SDK에서 onComplete를 호출됩니다.
...
path | 서브 스트림 |
videoLayer | 서브 스트림을 출력할 화면 |
반환값
서브 스트림이 추가된 인덱스 0보다 작으면 에러 멀티뷰에서 메인과 sub 플레이어의 출력 화면을 바꾸는 함수
...
role | 메인 화면으로 바꿀 플레이어의 role |
반환값
성공 : Sub 화면으로 이동된 플레이어 role, 실패 : IndexOutOfBoundsException 발생 재생 준비가 완료를 응답받는 인터페이스
...
매개변수
path | 남아있는 용량을 가져올 경로 |
반환값
남아있는 용량
static DecoderType com.kollus.sdk.media.util.Utils.getDecoderType (Context context)[static]
코덱 타입을 가져오는 함수
매개변수
context | App Context |
반환값
코덱 타입
참고
DecoderType
static DEVICE_TYPE com.kollus.sdk.media.util.Utils.getDeviceType (Context context)[static]
...
context | App Context |
참고
DEVICE_TYPE
반환값
디바이스 타입
static String com.kollus.sdk.media.util.Utils.getDirectoryJSON (Context context, String prefKey)[static]
...
context | App Context |
prefKey | 저장된 JSON 데이터의 키 |
반환값
JSON 데이터
static String com.kollus.sdk.media.util.Utils.getDirectoryJSONByPath (Context context, String path, String prefKey)[static]
...
context | App Context |
path | 불러올 경로 |
prefKey | 저장된 JSON 데이터의 키 |
반환값
JSON 데이터
static String com.kollus.sdk.media.util.Utils.getFileMD5 (File updateFile)[static]
...
매개변수
updateFile | 체크섬을 가져올 파일 |
반환값
체크섬
static long com.kollus.sdk.media.util.Utils.getFolderSize (File directory)[static]
...
매개변수
directory | 사이즈를 가져올 폴더 |
반환값
사용하는 용량량
static String com.kollus.sdk.media.util.Utils.getPlayerId (Context context)[static]
플레이어 ID를 가져오는 함수
매개변수
context | App Context |
반환값
플레이어 ID
static String com.kollus.sdk.media.util.Utils.getPlayerIdMd5 (Context context)[static]
내부적으로 사용하는 플레이어 ID를 생성하는 함수 16bytes 헥사스트링임(32자).
매개변수
context | App Context |
반환값
플레이어 ID 체크섬
static String com.kollus.sdk.media.util.Utils.getPlayerIdSha1 (Context context)[static]
대외적으로 사용하는 플레이어 ID를 생성하는 함수 길이 제한이 없음.
매개변수
context | App Context |
반환값
플레이어 ID 체크섬
static int com.kollus.sdk.media.util.Utils.getPlayerType ()[static]
생성될 플레어 타입을 가져오는 함수
반환값
플레이어 타입 (PLAYER_TYPE_NATIVE, PLAYER_TYPE_KOLLUS)
...
렌더링 방식을 가져오는 함수
매개변수
context | App Context |
반환값
렌더링 방식 @show @MediaPlayer.RENDER_MODE
...
플레이어가 사용하는 스토리지 경로를 가져오는 함수
매개변수
context | App Context |
반환값
저장된 경로
static String com.kollus.sdk.media.util.Utils.getString (JSONObject json, String key)[static]
...
json | JSON데이터 |
key | 가져올 key |
반환값
주어진 key의 String값
static long com.kollus.sdk.media.util.Utils.getTotalMemorySize (String path)[static]
주어진 경로의 SD카드의 전체 용량을 가져오는 함수
매개변수
path | 전체 용량을 가져올 경로 |
반환값
전체 용량
static Object com.kollus.sdk.media.util.Utils.invoke (Object obj, String methodName, Object[] objList)[static]
...
obj | invoke를 원하는 클래스 |
methodName | invoke할 클래스의 함수 |
objList | Object 리스트 |
반환값
invoke된 함수
static boolean com.kollus.sdk.media.util.Utils.isRooting ()[static]
루팅 여부를 확인하는 함수
반환값
루팅 여부
static boolean com.kollus.sdk.media.util.Utils.makeDirectory (String path)[static]
주어진 경로로 폴더를 만드는 함수
매개변수
path | 경로 |
반환값
폴더 생성 여부
static String com.kollus.sdk.media.util.Utils.makeMD5 (String param)[static]
주어진 문자의 MD5 체크섬을 가져오는 함수
매개변수
param | 체크섬을 가져올 문자 |
반환값
체크섬
static String com.kollus.sdk.media.util.Utils.makeSHA1 (String param)[static]
주어진 문자의 SHA1 체크섬을 가져오는 함수
매개변수
param | 체크섬을 가져올 문자 |
반환값
체크섬
static void com.kollus.sdk.media.util.Utils.saveDirectoryJSON (Context context, String dbPath, String jsonString)[static]
...
주어진 밀리초를 String형식으로 가져오는 함수 예 : 1:10:59, 10:59
매개변수
timeMs | 시간(밀리초) |
반환값
정형화된 시간
static String com.kollus.sdk.media.util.Utils.stringForTime (String dayString, String hourString, String minString, String secString, int timeMs)[static]
...
dayString | 날짜 구분자 |
hourString | 시간 구분자 |
minString | 분 구분자 |
secString | 초 구분자 |
timeMs | 시간(밀리초) |
반환값
정형화된 시간
static String com.kollus.sdk.media.util.Utils.stringForTimeHHMMSS (int timeMs)[static]
주어진 밀리초를 String형식으로 가져오는 함수 예 : 01:10:59
매개변수
timeMs | 시간(밀리초) |
반환값
정형화된 시간
static String com.kollus.sdk.media.util.Utils.stringForTimeHMMSS (int timeMs)[static]
주어진 밀리초를 String형식으로 가져오는 함수 예 : 1:10:59
매개변수
timeMs | 시간(밀리초) |
반환값
정형화된 시간
static String com.kollus.sdk.media.util.Utils.stringForTimeMMSS (int timeMs)[static]
주어진 밀리초를 String형식으로 가져오는 함수 예 : 10:59
매개변수
timeMs | 시간(밀리초) |
반환값
정형화된 시간
멤버 데이터 문서화
final int com.kollus.sdk.media.util.Utils.PLAYER_TYPE_EXO = 3[static]
...