iOS SDK_API References

iOS SDK_API References

最終更新: 2025.06.30_Review



iOS API References

API文書情報

  • 日付:2025.05.28


Kollus Bookmarkクラス参照



#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

Kollus Content クラス参照



#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

プレイヤータイプ:hwswnative

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]

コンテンツ·タイトル

<KollusPlayer Bookmark Delegate>プロトコルを参照



#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

出力される字幕データ



    Copyright © CATENOID, lnc. All Rights Reserved.
    E-mail. jp_sales@catenoid.net | Tel. 03-4405-8462