이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Roku용 IMA DAI SDK

클래스 ima

메서드

disableLogging, getStreamManager, initSdk, requestStream

IMA SDK를 제어하는 전역 함수입니다.

`disableLogging()`

SDK 로깅을 사용 중지합니다. 로깅은 기본적으로 사용 설정되어 있습니다.

`getStreamManager()`

사용 가능한 경우 스트림 관리자를 반환합니다. 스트림 관리자가 아직 사용 가능하지 않으면 잘못됨이 반환됩니다. 스트림 관리자를 만드는 중에 오류가 발생하면 오류 객체가 반환됩니다.

object 반환: 스트림 관리자 또는 오류 객체입니다.

`initSdk(settings)`

SDK를 초기화합니다.

매개변수	유형	설명
`settings`	`object`	선택적 IMA 설정 객체입니다.

`requestStream(streamRequest)`

비동기 스트림 요청을 시작합니다. 이 메서드를 호출하면 제어가 플레이어에게 즉시 반환됩니다.

object를 반환합니다. 오류가 없으면 오류 또는 잘못됨

매개변수	유형	설명
`streamRequest`	`object`

이름	유형	설명
`adPosition`		광고 시점의 광고 색인입니다. 단독 광고의 경우 색인은 `1`입니다.
`duration`		휴식 시간의 최대 길이(초) 또는 알 수 없는 경우 `-1`입니다.
`podIndex`		라이브 스트림의 경우 광고 시점 ID를 포드 색인으로 반환하거나 프리롤의 경우 `0`를 반환합니다. 라이브 스트림에는 포스트롤이 없습니다. 기본값은 `-2`입니다. VOD의 경우 광고 모음의 색인을 반환합니다. 프리롤 광고 모음의 경우 `0`을 반환합니다. 미드롤의 경우 `1`, `2`, ..., n을 반환합니다. 포스트롤 포드의 경우 n+1...n+x를 반환합니다. 이 광고가 광고 모음에 속하지 않거나 이 광고 모음이 재생목록에 속하지 않는 경우 기본값은 `0`입니다.
`timeOffset`		콘텐츠 내 광고 모음의 위치(초)입니다. 프리롤은 `0`를 반환하고, 포스트롤은 `-1`를 반환하며, 미드롤은 포드의 예약된 시간을 반환합니다.
`totalAds`		이 광고 시점에 포함된 총 광고 수입니다. 독립형 광고의 경우 값은 `1`입니다.

이름	유형	설명
`AD_PERIOD_ENDED`		스트림이 광고 또는 슬레이트에서 콘텐츠로 전환될 때마다 실행됩니다. 광고가 두 번째로 재생되거나 광고로 탐색할 때도 실행됩니다.
`AD_PERIOD_STARTED`		스트림이 콘텐츠에서 광고 또는 슬레이트로 전환될 때마다 실행됩니다. 광고가 두 번째로 재생되거나 광고로 탐색할 때도 실행됩니다.
`COMPLETE`		광고 재생이 완료되면 발생합니다.
`ERROR`		오류가 발생하면 발생합니다.
`FIRST_QUARTILE`		광고 재생 헤드가 첫 번째 분위수를 넘으면 실행됩니다.
`ICON_FALLBACK_IMAGE_CLOSED`		사용자가 아이콘 대체 이미지 대화상자를 닫을 때 실행됩니다.
`ICON_FALLBACK_IMAGE_SHOWN`		아이콘 대체 이미지가 표시될 때 실행됩니다.
`MIDPOINT`		광고 플레이헤드가 중점을 지나면 발생합니다.
`PROGRESS`		광고 진행 상황이 업데이트되면 발생합니다.
`SKIPPABLE_STATE_CHANGED`		광고 건너뛸 수 있는 상태가 변경되면 실행됩니다.
`SKIPPED`		광고가 건너뛰어지면 발생합니다.
`START`		광고 재생이 시작되면 발생합니다.
`THIRD_QUARTILE`		광고 재생 헤드가 3분위수를 넘으면 발생합니다.

이름	유형	설명
`adBreakInfo`		이 광고가 포함된 전체 시점과 관련된 정보입니다.
`adDescription`		광고 설명입니다.
`adId`		광고의 ID 또는 알 수 없는 경우 빈 문자열입니다.
`adSystem`		광고 소재를 제공하는 광고 시스템입니다.
`adTitle`		광고의 제목입니다.
`advertiserName`		게재 당사자가 정의한 광고주 이름입니다.
`companions`		VAST 응답에 지정된 컴패니언 광고입니다.
`creativeAdId`		광고의 ISCI (업계 표준 상업용 식별자) 코드입니다. VAST 응답에서 선택된 광고 소재의 광고 ID입니다.
`creativeId`		광고에 선택된 광고 소재의 ID입니다.
`currentTime`		광고 내 현재 시간(초)입니다. 알 수 없는 경우에는 -1입니다.
`dealId`		현재 광고의 래퍼 체인에 있는 첫 번째 거래 ID를 반환합니다(상단부터 시작).
`duration`		이 단일 광고의 길이(초)입니다. 알 수 없는 경우에는 -1입니다.
`skipOffset`		광고를 건너뛸 수 있게 되는 데 걸리는 시간 또는 알 수 없는 경우 -1입니다.
`universalAdIDRegistry`		선택한 광고 소재의 범용 광고 ID가 카탈로그화된 등록처 웹사이트의 URL을 식별하는 데 사용되는 문자열입니다.
`universalAdIDValue`		광고에 선택된 광고 소재의 범용 광고 ID입니다.
`wrappers`		이 광고의 래퍼 정보가 포함된 ima.WrapperInfo 배열입니다. 순서는 외부 래퍼에서 내부 래퍼로 진행됩니다.

이름	유형	설명
`apiFramework`		이 광고를 실행하는 데 필요한 API 또는 사용할 수 없는 경우 잘못됨
`creativeType`		일반적으로 mimetype인 광고 소재 유형을 나타냅니다.
`height`		컴패니언의 높이입니다(단위: 픽셀). 사용할 수 없는 경우 0입니다.
`trackingEvents`		키가 이벤트이고 값이 해당 이벤트에 핑할 URL 목록인 추적 이벤트 맵입니다.
`url`		이 컴패니언의 정적 리소스의 URL입니다.
`width`		컴패니언의 너비입니다(단위: 픽셀). 사용할 수 없는 경우 0입니다.

이름	유형	설명
`end`		큐포인트의 종료 시간(초)입니다. 이는 광고 시점에 해당합니다.
`hasPlayed`		큐포인트가 이미 재생되었음을 나타내는 불리언입니다.
`start`		큐포인트의 시작 시간(단위: 초)입니다. 이는 광고 시점에 해당합니다.

이름	유형	설명
`id`		오류의 ID입니다. 오류 코드 목록은 ErrorEvent 상수를 참고하세요.
`info`		오류에 대한 추가 정보입니다.
`type`		이 객체의 유형을 나타내기 위해 항상 error로 설정합니다.

이름	유형	설명
`BAD_STREAM_REQUEST`		스트림 요청이 올바르게 채워지지 않았습니다.
`COULD_NOT_LOAD_STREAM`		스트림을 로드할 수 없습니다.
`ERROR`		알 수 없는 오류입니다.
`INVALID_RESPONSE`		서버 응답이 유효하지 않습니다.
`STREAM_API_KEY_NOT_VALID`		제공된 API 키가 서버에서 수락되지 않았습니다.

이름	유형	설명
`format`		동영상 형식(hls 또는 dash) ima.StreamFormat에 정의됩니다.
`manifest`		스트림의 URL입니다.
`streamId`		스트림의 고유 ID입니다.
`streamType`		동영상 유형: 라이브 또는 주문형 ima.StreamType에 정의됩니다.
`subtitles`		자막(있는 경우) 그렇지 않으면 잘못된 것입니다.

매개변수	유형	설명
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

매개변수	유형	설명
`streamManifest`	`string`	광고가 스티치된 스트림 매니페스트 URL입니다.
`streamSubtitle`	`ifArray>\|Invalid`	스트림과 연결된 자막 또는 연결된 자막이 없는 경우 `Invalid`입니다.

이름	유형	설명
`adTagParameters`		선택사항입니다. 스트림 요청에서 제한된 수의 광고 태그 매개변수를 재정의할 수 있습니다. 자세한 내용은 타겟팅 매개변수를 스트림에 공급하기를 참고하세요. 스트림 변형 환경설정에 dai-ot 및 dai-ov 매개변수를 사용할 수도 있습니다. 자세한 내용은 스트림 변형 매개변수 재정의를 참고하세요.
`adUiNode`		광고 UI가 표시되는 장면 그래프 노드입니다. IMA는 광고 중에 이 요소에 이 광고가 표시된 이유 및 건너뛰기 버튼과 같은 요소를 배치합니다. 요소는 전체 동영상 요소를 오버레이해야 합니다.
`apiKey`		선택사항입니다. 이러한 키는 스트림 요청을 인증하는 데 사용할 수 있습니다. DAI 인증 키는 DFP UI에서 설정해야 합니다.
`assetKey`		라이브 스트림에 필요합니다. 재생할 스트림을 결정하는 데 사용됩니다. 라이브 스트림 요청 애셋 키는 DFP UI에서 찾을 수 있는 식별자입니다.
`authToken`		스트림 요청 승인 토큰입니다. 더 엄격한 콘텐츠 승인을 위해 API 키 대신 사용됩니다. 게시자는 이 토큰을 기반으로 개별 콘텐츠 스트림 승인을 제어할 수 있습니다.
`contentSourceId`		주문형 스트림에 필요합니다. cmsid는 DFP UI의 DFP 동영상 콘텐츠 소스에서 가져옵니다.
`customAssetKey`		맞춤 애셋 키는 재생할 스트림을 결정하는 데 사용됩니다. 스트림 요청을 제공하는 pod에는 맞춤 애셋 키가 필요합니다.
`format`		스트림의 형식입니다. 기본값은 `ima.StreamFormat.HLS`입니다.
`networkCode`		스트림 요청을 하는 게시자의 네트워크 코드입니다. 네트워크 코드는 createPodLiveStreamRequest 또는 createPodVodStreamRequest로 이루어진 광고 모음 게재 스트림 요청에 필요합니다. 이러한 코드는 createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest 또는 createVideoStitcherVodStreamRequestWithVodConfig로 이루어진 Cloud 스티칭 스트림 요청에도 필요합니다. 이 코드는 선택사항이며 createLiveStreamRequest 또는 createVodStreamRequest로 이루어진 전체 서비스 스트림 요청에 권장됩니다. 네트워크 코드를 추가하면 프로그래매틱 제한 광고 사용 설정과 같이 Ad Manager UI에서 선택한 설정이 적용됩니다. Pod 게재 및 Cloud 스티칭의 경우 네트워크 코드를 추가하면 스트림이 검색되고 재생됩니다. 네트워크 코드를 찾으려면 이 도움말을 참고하세요.
`player`		플레이어 인터페이스의 구현입니다.
`ppid`		지원 중단되었습니다. adTagParameters를 사용합니다. 선택사항입니다. DFP Audience 게시자 제공 식별자입니다.
`streamActivityMonitorId`		스트림 활동 모니터링 도구로 스트림을 디버그하는 데 사용할 ID입니다. 이는 게시자가 스트림 활동 모니터링 도구에서 스트림 로그를 쉽게 찾을 수 있는 편리한 방법을 제공하는 데 사용됩니다.
`videoId`		주문형 스트림에 필요합니다. 동영상 콘텐츠 소스의 식별자입니다.
`videoObject`		클라이언트 앱에서 동영상 재생을 담당하는 동영상 객체 (예: 동영상 roSGNode)입니다. 이 객체는 실시간 HLS ID3 이벤트의 타이밍을 적절하게 조정하는 데 사용할 다양한 데이터를 폴링합니다.
`videoStitcherSessionOptions`		세션 옵션은 VideoStitcher streamRequests의 동영상 스티처 관련 매개변수를 설정하는 데 사용됩니다.

매개변수	유형	설명
`assetKey`	`string`
`apiKey`	`string`	반환된 `ima.StreamRequest`의 `ima.StreamRequest.apiKey` 속성에 할당된 매개변수입니다. API 키가 없는 경우 빈 문자열을 전달합니다.
`networkCode`	`string`	스트림 요청을 실행하는 게시자의 네트워크 코드입니다. 네트워크 코드를 포함하는 것은 선택사항이지만 권장됩니다.

매개변수	유형	설명
`contentSourceId`	`string`
`videoId`	`string`
`apiKey`	`string`	반환된 `ima.StreamRequest`의 `ima.StreamRequest.apiKey` 속성에 할당된 매개변수입니다. API 키가 없는 경우 빈 문자열을 전달합니다.
`networkCode`	`string`	스트림 요청을 실행하는 게시자의 네트워크 코드입니다. 네트워크 코드를 포함하는 것은 선택사항이지만 권장됩니다.

이름	유형	설명
`LIVE`		동영상이 게시되었습니다.
`VOD`		동영상은 주문형입니다.

매개변수	유형	설명
`adTagUrl`	`string`
`networkCode`	`string`
`contentSourceUrl`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

매개변수	유형	설명
`vodConfigId`	`string`
`networkCode`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

Roku용 IMA DAI SDK

클래스 ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

클래스 ima.AdBreakInfo

속성

createAdBreakInfo()

클래스 ima.AdEvent

속성

클래스 ima.AdInfo

속성

createAdInfo()

클래스 ima.Companion

속성

createCompanion()

클래스 ima.CuePoint

속성

createCuePoint()

클래스 ima.Error

속성

createError()

클래스 ima.ErrorEvent

속성

클래스 ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

클래스 ima.StreamFormat

속성

클래스 ima.StreamInfo

속성

createStreamInfo()

ima.StreamManager 클래스

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

클래스 ima.StreamRequest

속성

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

클래스 ima.StreamType

속성

ima.WrapperInfo 클래스

속성

createWrapperInfo()

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

`createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`