StreamManager
동적 광고 삽입 스트림을 처리합니다. DAI 백엔드와의 상호작용을 관리하고 추적 핑을 처리하며 스트림 및 광고 이벤트를 게시자에게 전달합니다. 이 관리자는 특정 광고의 관리자가 아니라 전체 스트림의 관리자이므로 BaseAdsManager에서 상속받지 않습니다.
생성자
StreamManager
new StreamManager(videoElement, adUiElement, uiSettings)
생성자입니다.
매개변수 |
|
---|---|
videoElement |
재생이 발생하는 HTML 동영상 요소입니다. 값은 null이 아니어야 합니다. |
adUiElement |
선택사항 광고 UI 요소를 보유하는 데 사용할 HTML 요소입니다. 이 요소는 동영상 재생과 동일한 높이와 너비여야 하며 동영상 위에 직접 겹쳐져야 합니다. 제공하지 않으면 UI가 표시되지 않으며 건너뛸 수 있는 광고와 같이 UI가 필요한 광고가 요청되지 않습니다. |
uiSettings |
선택사항 이 스트림에 사용할 UI 설정입니다. 값은 null이 아니어야 합니다. |
- 생성 값
-
입력 매개변수가 요구사항을 충족하지 않는 경우
속성
clickElement
null이 아닌 HTMLElement
clickElement
null이 아닌 HTMLElement
streamMonitor
null이 아닌 PodServingStreamMonitor
메서드
addEventListener
addEventListener(type, listener)는 void를 반환합니다.
지정된 이벤트 유형의 리스너를 추가합니다.
매개변수 |
|
---|---|
유형 |
문자열 수신 대기할 이벤트의 유형. |
listener |
function(non-null StreamEvent) 이 유형의 이벤트가 발생할 때마다 호출되는 함수입니다. |
- 반환 값
-
void
contentTimeForStreamTime
contentTimeForStreamTime(streamTime)은 숫자를 반환합니다.
지정된 스트림 시간의 광고가 없는 콘텐츠 시간을 반환합니다. 라이브 스트림의 지정된 스트림 시간을 반환합니다.
매개변수 |
|
---|---|
streamTime |
숫자 삽입된 광고가 포함된 스트림 시간 (초)입니다. |
- 반환 값
-
number
광고가 삭제된 후 지정된 스트림 시간에 해당하는 콘텐츠 시간입니다.
초점
focus()는 void를 반환합니다.
건너뛰기 버튼(있는 경우)에 포커스를 둡니다. 아이콘이나 양방향 광고 소재와 같은 양방향 요소가 없으면 포커스가 양방향 요소에 맞춰집니다.
- 반환 값
-
void
getAdSkippableState
getAdSkippableState()는 불리언을 반환합니다.
현재 광고를 건너뛸 수 있으면 true를 반환합니다. 이 값이 변경되면 StreamManager
에서 StreamEvent.SKIPPABLE_STATE_CHANGED
이벤트가 발생합니다.
- 반환 값
-
boolean
현재 광고를 건너뛸 수 있으면 true, 그렇지 않으면 false입니다.
loadStreamMetadata
loadStreamMetadata()가 void를 반환합니다.
SDK에 광고 메타데이터를 로드하도록 요청한 다음 StreamEvent.LOADED를 브로드캐스트합니다. 이는 서드 파티 동영상 스티처에서 스트림 매니페스트를 가져온 후에 수동으로 트리거해야 합니다. 서드 파티 동영상 스티처를 사용하는 포드 VOD 제공에만 사용되며 다른 스트림 요청에는 아무런 작업도 하지 않습니다.
- 반환 값
-
void
onTimedMetadata
onTimedMetadata(metadata)가 void를 반환합니다.
처리된 메타데이터 사전을 전달합니다. 사전은 사용자 정의 메타데이터 문자열을 값으로 사용하는 키 'TXXX'를 예상합니다.
플레이어가 원시 메타데이터를 제공하는 경우 대신 StreamManager.processMetadata
를 호출하세요.
매개변수 |
|
---|---|
메타데이터 |
(null 또는 문자열 속성이 있는 null이 아닌 객체) 메타데이터 사전입니다. |
- 반환 값
-
void
previousCuePointForStreamTime
previousCuePointForStreamTime(streamTime) returns (null or CuePoint)
지정된 스트림 시간의 이전 큐포인트를 반환합니다. 이러한 큐포인트가 없으면 null을 반환합니다. 이 메서드는 스냅백과 같은 기능을 구현하는 데 사용되며 게시자가 사용자가 광고 시점으로 돌아가기 위해 탐색했음을 감지할 때 호출됩니다.
매개변수 |
|
---|---|
streamTime |
숫자 탐색된 스트림 시간입니다. |
- 반환 값
-
(null or non-null CuePoint)
지정된 스트림 시간의 이전 큐포인트입니다.
processMetadata
processMetadata(type, data, timestamp)는 void를 반환합니다.
라이브 스트림의 시간 표시 메타데이터를 처리합니다. 동영상 플레이어가 타임스탬프와 함께 파싱되지 않은 메타데이터를 제공하는 경우 사용하고, 그렇지 않으면 StreamManager.onTimedMetadata
를 호출합니다.
매개변수 |
|
---|---|
유형 |
문자열 메타데이터 유형입니다. HLS의 경우 'ID3'이거나 DASH의 경우 이벤트 메시지 스키마 ID URI여야 합니다. |
데이터 |
(문자열 또는 null이 아닌 Uint8Array) 원시 태그 데이터 ID3의 경우 전체 원시 태그 데이터여야 합니다. DASH 이벤트 메시지의 경우 메시지 데이터 문자열입니다. |
타임스탬프 |
숫자 데이터를 처리해야 하는 시간(초)입니다. DASH의 경우 이벤트 메시지 시작 시간입니다. |
- 반환 값
-
void
removeEventListener
removeEventListener(type, listener)는 void를 반환합니다.
지정된 이벤트 유형의 리스너를 삭제합니다. 리스너 함수는 이전에 addEventListener
에 전달된 함수와 참조로 동일해야 합니다.
매개변수 |
|
---|---|
유형 |
문자열 리스너를 삭제할 이벤트 유형입니다. |
listener |
function(non-null StreamEvent) 리스너로 삭제할 함수입니다. |
- 반환 값
-
void
replaceAdTagParameters
replaceAdTagParameters(adTagParameters)는 void를 반환합니다.
라이브 스트림의 경우 게재 예정 광고 요청에 사용하는 모든 광고 태그 매개변수를 대체합니다.
매개변수 |
|
---|---|
adTagParameters |
문자열 속성이 있는 객체 새 광고 태그 매개변수 문자열 값이 있어야 합니다. 값은 null이 아니어야 합니다. |
- 반환 값
-
void
requestStream
requestStream(streamRequest)은 void를 반환합니다.
제공된 스트림 매개변수를 사용하여 스트림을 로드하도록 요청합니다.
매개변수 |
|
---|---|
streamRequest |
스트림 메타데이터를 로드하는 매개변수를 포함합니다. 값은 null이 아니어야 합니다. |
- 반환 값
-
void
재설정
reset()은 void를 반환합니다.
스트림 관리자를 재설정하고 연속 폴링을 삭제합니다.
- 반환 값
-
void
setClickElement
setClickElement(clickElement)은 void를 반환합니다.
광고 클릭연결 요소를 설정합니다. 이 요소는 광고가 재생되는 동안 클릭 또는 탭 수신기로 사용되며 현재 페이지에서 벗어나게 될 수 있습니다. 이제 지원 중단되었으며 대신 adUiElement를 StreamManager에 전달해야 합니다. adUiElement가 StreamManager 생성자에 제공되면 이 메서드는 무효 작업이 됩니다.
매개변수 |
|
---|---|
clickElement |
(null 또는 null이 아닌 요소) 광고 클릭연결로 사용되는 요소입니다. |
- 지원 중단됨
- 대신 StreamManager 생성자에 adUiElement를 제공합니다.
- 반환 값
-
void
streamTimeForContentTime
streamTimeForContentTime(contentTime)은 숫자를 반환합니다.
지정된 콘텐츠 시간의 광고가 포함된 스트림 시간을 반환합니다. 라이브 스트림의 지정된 콘텐츠 시간을 반환합니다.
매개변수 |
|
---|---|
contentTime |
숫자 광고가 없는 콘텐츠 시간 (초)입니다. |
- 반환 값
-
number
광고가 삽입된 후 지정된 콘텐츠 시간에 해당하는 스트림 시간입니다.