네임스페이스: videojs | Brightcove Player API 설명서

videojs() 함수는 사용자가 Player 인스턴스를 생성하기 위한 기본 기능과 기본 라이브러리 네임스페이스를 겸합니다.

기존 Player 인스턴스의 getter로도 사용할 수 있습니다. 그러나 우리는강하게사용을 권장 videojs.getPlayer()의도하지 않은 초기화 가능성을 방지하기 때문입니다.

JSDoc 템플릿의 제한 으로 인해 이를 함수와 네임스페이스로 적절하게 문서화할 수 없으므로 여기에 함수 서명이 문서화되어 있습니다.

인수

ID

string|요소, 필수

동영상 요소 또는 동영상 요소 ID입니다.

옵션

개체, 선택 사항

설정을 제공하기 위한 옵션 객체. 참조: 옵션 가이드 .

준비된

Component~ReadyCallback , 선택 사항

플레이어 와 기술이 준비되면 호출되는 함수입니다.

반환 값

videojs() 함수는 Player 인스턴스를 반환합니다.

클래스

오디오트랙 모듈:videojs~videojs.AudioTrack
이벤트 대상 모듈:videojs~videojs.EventTarget
TextTrack 모듈:videojs~videojs.TextTrack
비디오트랙 모듈:videojs~videojs.VideoTrack

회원

정적 브라우저 :객체 video.js , 라인 365

개체로서의 브라우저 유틸리티 모듈 에 대한 참조입니다.

참조:

브라우저

정적 돔 :객체 video.js , 493행

개체로서의 DOM 유틸리티 모듈 에 대한 참조입니다.

참조:

정적 로그 :함수 video.js , 라인 432

개체로서의 로그 유틸리티 모듈 에 대한 참조입니다.

참조:

통나무

정적 옵션 :객체 video.js , 라인 241

전역 옵션 개체입니다. 플레이어가 생성될 때 재정의가 지정되지 않은 경우 적용되는 설정입니다.

정적 플레이어 :객체 player.js , 라인 5243

플레이어의 글로벌 열거.

키는 플레이어 ID이고 값은 Player 인스턴스이거나 폐기된 플레이어의 경우 null 입니다.

정적 TOUCH_ENABLED :부울 video.js , 374행

대신 browser.TOUCH_ENABLED를 사용하십시오. 4.x와의 하위 호환성을 위해서만 포함되었습니다.

더 이상 사용되지 않음:

버전 5.0부터는 browser.TOUCH_ENABLED를 대신 사용하십시오.

정적 URL : 개체 video.js , 라인 501

객체로서의 URL 유틸리티 모듈 에 대한 참조입니다.

참조:

정적 버전 :문자열 video.js , 233행

현재 Video.js 버전. 시맨틱 버전 관리를 따릅니다.

방법

공전 addLanguage (코드, 데이터)→ {오브젝트 video.js , 라인 415

모든 플레이어가 사용할 수 있도록 언어를 추가합니다. 예: videojs.addLanguage('es', { '안녕하세요': '안녕' });

매개 변수 :

이름	유형	설명
`암호`	끈	언어 코드 또는 사전 속성
`데이터`	물체	변환할 데이터 값

반환:

객체 -

결과 언어 사전 객체

정적 바인드 (컨텍스트, fn, uid opt ) → {function} utils/fn.js , 30행

바인드(프록시 또는 컨텍스트라고도 함). 함수의 컨텍스트를 변경하는 간단한 방법입니다.

또한 이벤트에서 쉽게 제거할 수 있도록 함수에 고유 ID를 저장합니다.

매개 변수 :

이름	유형	속성	설명
`문맥`	혼합		범위로 바인딩할 개체입니다.
`fn`	기능		범위에 바인딩할 함수입니다.
`액체`	숫자	<선택 과목>	설정할 기능에 대한 선택적 고유 ID

반환:

기능 -

주어진 컨텍스트에 바인딩될 새 함수

정적 computedStyle (엘, 소품) utils/computed-style.js , 23행

안전한 getComputedStyle.

이는 Firefox에서 플레이어가 display:none 을 사용하여 iframe에 로드되면 getComputedStyle이 null 을 반환하므로 이러한 경우 플레이어가 중단되지 않도록 null 검사를 수행하기 때문에 필요합니다.

매개 변수 :

이름	유형	설명
`엘자`	요소	계산된 스타일을 원하는 요소
`소품`	끈	원하는 속성 이름

참조:

https://bugzilla.mozilla.org/show_bug.cgi?id=548397

정적 createTimeRange (시작, 종료) utils/time-ranges.js , 라인 137

만들기시간 범위흉내내는 물체 HTML5 TimeRanges 인스턴스 .

매개 변수 :

이름	유형	설명
`시작`	번호 \| 정렬.< 정렬>	단일 범위(숫자) 또는 범위 배열(각각 두 숫자의 배열 배열)의 시작입니다.
`끝`	숫자	단일 범위의 끝입니다. `시작` 인수의 배열 형식과 함께 사용할 수 없습니다.

정적 createTimeRanges (시작, 종료) utils/time-ranges.js , 라인 137

만들기시간 범위흉내내는 물체 HTML5 TimeRanges 인스턴스 .

매개 변수 :

이름	유형	설명
`시작`	번호 \| 정렬.< 정렬>	단일 범위(숫자) 또는 범위 배열(각각 두 숫자의 배열 배열)의 시작입니다.
`끝`	숫자	단일 범위의 끝입니다. `시작` 인수의 배열 형식과 함께 사용할 수 없습니다.

정적 deregisterPlugin (이름) plugin.js , 386행

Video.js 플러그인 등록을 취소합니다.

매개 변수 :

이름	유형	설명
`이름`	끈	등록을 취소할 플러그인의 이름입니다. 기존 플러그인과 일치하는 문자열이어야 합니다.

던지기:

기본 플러그인 등록을 취소하려는 경우.
유형 오류

정적 확장 (superClass, subClassMethods opt ) → {function} extend.js , 33행

extends 키워드를 사용하여 ES 서브클래싱을 에뮬레이션하여 기존 클래스를 서브클래싱하는 데 사용됩니다.

매개 변수 :

이름	유형	속성	기본값	설명
`슈퍼클래스`	기능			상속받을 클래스
`하위 클래스 메서드`	물체	<선택 과목>	{}	새 클래스의 메서드

반환:

기능 -

superClass를 상속한 subClassMethods가 있는 새 클래스입니다.

더 이상 사용되지 않음:

예

var MyComponent = videojs.extend(videojs.getComponent('컴포넌트'), {
  myCustomMethod: 함수() {
    // 내 메서드에서 작업을 수행합니다.
  }
});

정적 formatTime (초, 가이드) → {string} utils/format-time.js , 라인 90

기본 시간 형식 함수 또는 setFormatTime 을 통해 제공된 사용자 정의 함수에 위임합니다.

시간 문자열(H:MM:SS 또는 M:SS)로 초 형식을 지정합니다. 가이드(초 단위)를 제공하면 가이드 길이를 덮기 위해 여러 개의 선행 0이 강제 적용됩니다.

매개 변수 :

이름	유형	설명
`초`	숫자	문자열로 변환할 시간(초)
`가이드`	숫자	이후 문자열을 모델링할 숫자(초)

반환:

문자열 -

H:MM:SS 또는 M:SS 형식의 시간

예

formatTime(125, 600) === "02:05"

정적 getAllPlayers () → {Array} video.js , 302행

현재 모든 플레이어의 배열을 반환합니다.

반환:

어레이 -

모든 플레이어의 배열입니다. 배열은 Object.keys가 제공하는 순서를 따르며 JavaScript 엔진마다 잠재적으로 다를 수 있습니다.

정적 getComponent (이름) → { 구성 요소 } component.js , 라인 1727

등록된 이름을 기반으로 Component를 가져옵니다.

매개 변수 :

이름	유형	설명
`이름`	끈	가져올 구성 요소의 이름입니다.

반환:

구성요소 -

지정된 이름으로 등록된 Component 입니다.

static getPlayer (id) → { 플레이어 |미정의} video.js , 라인 265

ID 또는 DOM 요소를 기반으로 단일 플레이어를 가져옵니다.

이는 요소 또는 ID에 연결된 Video.js 플레이어가 있는지 확인하고 싶지만 없는 경우 만들지 않으려는 경우에 유용합니다.

매개 변수 :

이름	유형	설명
`ID`	문자열 \| 요소	HTML 요소 - `<동영상>` , `<오디오>` , 또는 `<비디오 js>` - 또는 그러한 요소의 `id` 와 일치하는 문자열.

반환:

플레이어 | 정의되지 않은 -

인수와 일치하는 플레이어 인스턴스가 없는 경우 플레이어 인스턴스 또는 정의되지 않음 .

정적 getPlayers () → {객체} video.js , 249행

이름 유형 속성 설명

URL

끈

확인할 URL입니다.

winLoc

물체

<선택 과목>

URL을 확인할 도메인, 기본값은 window.location입니다.

속성

이름	유형	속성	설명
`규약`	끈	<선택 과목>	창 위치 프로토콜의 기본값은 window.location.protocol입니다.
`주인`	끈	<선택 과목>	창 위치 호스트는 기본적으로 window.location.host입니다.

반환:

부울 -

도메인 간 요청인지 여부입니다.

정적 병합 옵션 (…소스) → {객체} utils/merge-options.js , 24행

두 개체를 재귀적으로 병합합니다.

lodash.merge 와 같은 심층 병합을 수행하지만 일반 객체만 병합합니다(배열, 요소 등이 아님).

비일반 개체 값은 가장 오른쪽 인수에서 직접 복사됩니다.

매개 변수 :

이름	유형	속성	설명
`출처`	정렬.< 물체>	<반복 가능>	새 개체로 병합할 하나 이상의 개체입니다.

반환:

객체 -

모든 소스의 병합 결과인 새 개체입니다.

정적 꺼짐 (요소, 유형 opt , fn opt ) utils/events.js , 라인 348

요소에서 이벤트 리스너를 제거합니다.

매개 변수 :

이름	유형	속성	설명
`원소`	요소 \| 물체		리스너를 제거할 개체입니다.
`유형`	문자열 \| 정렬.< 끈>	<선택 과목>	제거할 리스너 유형입니다. 요소에서 모든 이벤트를 제거하려면 포함하지 마십시오.
`fn`	EventTarget~EventListener	<선택 과목>	제거할 특정 리스너입니다. 이벤트 유형에 대한 리스너를 제거하려면 포함하지 마십시오.

정적 켜기 (요소, 유형, fn) utils/events.js , 라인 262

요소에 이벤트 리스너 추가 별도의 캐시 개체에 처리기 기능을 저장하고 요소에 대한 고유 ID(guid)와 함께 일반 처리기를 요소의 이벤트에 추가합니다.

매개 변수 :

이름	유형	설명
`원소`	요소 \| 물체	리스너를 바인딩할 요소 또는 개체
`유형`	문자열 \| 정렬.< 끈>	바인딩할 이벤트 유형입니다.
`fn`	EventTarget~EventListener	이벤트 리스너.

정적 항목 (요소, 유형, fn) utils/events.js , 라인 487

이벤트에 대해 리스너를 한 번만 트리거합니다.

매개 변수 :

이름	유형	설명
`원소`	요소 \| 물체	바인딩할 요소 또는 개체입니다.
`유형`	문자열 \| 정렬.< 끈>	이벤트 이름/유형
`fn`	이벤트~이벤트리스너	이벤트 리스너 기능

정적 parseUrl (url) → {url:URLObject} utils/url.js , 43행

URL의 요소를 확인하고 구문 분석합니다.

매개 변수 :

이름	유형	설명
`URL`	스트링	구문 분석할 URL

반환:

url:URL객체 -

URL 세부 정보의 개체

정적 플러그인 (이름, 플러그인) video.js , 393행

Video.js에 플러그인을 등록하는 더 이상 사용되지 않는 방법

매개 변수 :

이름	유형	설명
`이름`	끈	플러그인 이름
`플러그인`	플러그인 \| 기능	플러그인 하위 클래스 또는 함수

더 이상 사용되지 않음:

videojs.plugin()은 더 이상 사용되지 않습니다. 대신 videojs.registerPlugin() 사용

static registerComponent (name, comp) → { 컴포넌트 } video.js , 328행

이름으로 참조할 수 있도록 구성 요소를 등록합니다. addChild component.addChild('myComponent') 또는 default children options { children: ['myComponent'] } 를 통해 다른 구성 요소에 추가할 때 사용됩니다.

참고: 추가하기 전에 구성 요소를 초기화할 수도 있습니다. component.addChild(new MyComponent());

매개 변수 :

이름	유형	설명
`이름`	끈	구성 요소의 클래스 이름
`비교`	요소	컴포넌트 클래스

반환:

구성요소 -

새로 등록된 컴포넌트

static registerPlugin (이름, 플러그인) → {function} plugin.js , 346행

Video.js 플러그인을 등록합니다.

매개 변수 :

이름	유형	설명
`이름`	끈	등록할 플러그인의 이름입니다. 문자열이어야 하며 `플레이어` 프로토타입의 기존 플러그인 또는 메서드와 일치하지 않아야 합니다.
`플러그인`	기능	`Plugin` 의 하위 클래스 또는 기본 플러그인의 기능.

반환:

기능 -

고급 플러그인의 경우 해당 플러그인의 공장 기능입니다. 기본 플러그인의 경우 플러그인을 초기화하는 래퍼 함수입니다.

정적 registerTech (이름, 기술) tech/tech.js , 라인 1015

videojs의 공유 목록에 기술을 등록합니다.

매개 변수 :

이름	유형	설명
`이름`	끈	등록할 `기술` 의 이름입니다.
`기술`	물체	등록할 `Tech` 클래스입니다.

정적 resetFormatTime () utils/format-time.js , 67행

formatTime을 기본 구현으로 재설정합니다.

정적 setFormatTime (customImplementation) utils/format-time.js , 60행

기본 formatTime 구현을 사용자 정의 구현으로 바꿉니다.

매개 변수 :

이름	유형	설명
`맞춤형 구현`	기능	기본 formatTime 구현 대신 사용될 함수입니다. 현재 시간(초)과 가이드(초)를 인수로 받습니다.

정적 트리거 (요소, 이벤트, 해시 옵션 ) → {boolean|undefined} utils/events.js , 라인 422

요소에 대한 이벤트 트리거

매개 변수 :

이름	유형	속성	설명
`원소`	요소 \| 물체		이벤트를 트리거할 요소
`이벤트`	이벤트대상~이벤트 \| 끈		문자열(유형) 또는 유형 속성이 있는 이벤트 객체
`해시시`	물체	<선택 과목>	이벤트와 함께 전달할 데이터 해시

반환:

부울 | 정의되지 않은 -

기본값이 금지된 경우 defaultPrevented 의 반대를 반환합니다. 그렇지 않으면 정의되지 않은 반환

정적 사용 (유형, 미들웨어) tech/middleware.js , 46행

미들웨어 개체를 반환하는 팩터리 함수를 통해 플레이어가 사용해야 하는 미들웨어를 정의합니다.

매개 변수 :

이름	유형	설명
`유형`	끈	일치시킬 MIME 유형 또는 모든 MIME 유형에 대해 `"*"` .
`미들웨어`	미들웨어팩토리	일치하는 유형에 대해 실행될 미들웨어 팩터리 기능입니다.

정적 xhr (옵션) → {XMLHttpRequest|XDomainRequest} video.js , 라인 459

크로스 브라우저 XMLHttpRequest 래퍼.

매개 변수 :

이름	유형	설명
`옵션`	물체	요청에 대한 설정입니다.

반환:

XMLHttp요청 | XDomainRequest -

요청 개체입니다.

참조:

https://github.com/Raynos/xhr

인수

ID

옵션

준비된

반환 값

클래스

오디오트랙 모듈:videojs~videojs.AudioTrack

이벤트 대상 모듈:videojs~videojs.EventTarget

TextTrack 모듈:videojs~videojs.TextTrack

비디오트랙 모듈:videojs~videojs.VideoTrack

회원

정적 브라우저 :객체 video.js , 라인 365

정적 돔 :객체 video.js , 493행

정적 로그 :함수 video.js , 라인 432

정적 옵션 :객체 video.js , 라인 241

정적 플레이어 :객체 player.js , 라인 5243

정적 TOUCH_ENABLED :부울 video.js , 374행

정적 URL : 개체

정적 버전 :문자열 video.js , 233행

방법

공전 addLanguage (코드, 데이터)→ {오브젝트 video.js , 라인 415

매개 변수 :

반환:

정적 바인드 (컨텍스트, fn, uid opt ) → {function} utils/fn.js , 30행

매개 변수 :

반환:

정적 computedStyle (엘, 소품) utils/computed-style.js , 23행

매개 변수 :

정적 createTimeRange (시작, 종료) utils/time-ranges.js , 라인 137

매개 변수 :

정적 createTimeRanges (시작, 종료) utils/time-ranges.js , 라인 137

매개 변수 :

정적 deregisterPlugin (이름) plugin.js , 386행

매개 변수 :

던지기:

정적 확장 (superClass, subClassMethods opt ) → {function} extend.js , 33행

매개 변수 :

반환:

예

정적 formatTime (초, 가이드) → {string} utils/format-time.js , 라인 90

매개 변수 :

반환:

예

정적 getAllPlayers () → {Array} video.js , 302행

반환:

정적 getComponent (이름) → { 구성 요소 } component.js , 라인 1727

매개 변수 :

반환:

static getPlayer (id) → { 플레이어 |미정의} video.js , 라인 265

매개 변수 :

반환:

정적 getPlayers () → {객체} video.js , 249행

반환:

static getPlugin (이름) → {function|undefined} plugin.js , 438행

매개 변수 :

반환:

static getPlugins (names opt ) → {Object|undefined} plugin.js , 라인 407

매개 변수 :

반환:

정적 getPluginVersion (이름) → {string} plugin.js , 라인 431

매개 변수 :

반환:

정적 getTech (이름) → { 기술 |정의되지 않음} tech/tech.js , 라인 1051

매개 변수 :

반환:

정적 isCrossOrigin (url, winLoc 선택 ) → {boolean} utils/url.js , 라인 155

매개 변수 :

속성

반환:

정적 병합 옵션 (…소스) → {객체} utils/merge-options.js , 24행

매개 변수 :

반환:

정적 꺼짐 (요소, 유형 opt , fn opt ) utils/events.js , 라인 348

매개 변수 :

정적 켜기 (요소, 유형, fn) utils/events.js , 라인 262

매개 변수 :

정적 항목 (요소, 유형, fn) utils/events.js , 라인 487

매개 변수 :

정적 parseUrl (url) → {url:URLObject} utils/url.js , 43행

매개 변수 :

오디오트랙
`모듈:videojs~videojs.AudioTrack`

이벤트 대상
`모듈:videojs~videojs.EventTarget`

TextTrack
`모듈:videojs~videojs.TextTrack`

비디오트랙
`모듈:videojs~videojs.VideoTrack`

정적 브라우저 :객체
`video.js` , `라인 365`

정적 돔 :객체
`video.js` , `493행`

정적 로그 :함수
`video.js` , `라인 432`

정적 옵션 :객체
`video.js` , `라인 241`

정적 플레이어 :객체
`player.js` , `라인 5243`

정적 TOUCH_ENABLED :부울
`video.js` , `374행`

정적 URL : 개체
`video.js` , `라인 501`

정적 버전 :문자열
`video.js` , `233행`

공전 addLanguage (코드, 데이터)→ {오브젝트
`video.js` , `라인 415`

정적 바인드 (컨텍스트, fn, uid opt ) → {function}
`utils/fn.js` , `30행`

정적 computedStyle (엘, 소품)
`utils/computed-style.js` , `23행`

정적 createTimeRange (시작, 종료)
`utils/time-ranges.js` , `라인 137`

정적 createTimeRanges (시작, 종료)
`utils/time-ranges.js` , `라인 137`

정적 deregisterPlugin (이름)
`plugin.js` , `386행`

정적 확장 (superClass, subClassMethods opt ) → {function}
`extend.js` , `33행`

정적 formatTime (초, 가이드) → {string}
`utils/format-time.js` , `라인 90`

정적 getAllPlayers () → {Array}
`video.js` , `302행`

정적 getComponent (이름) → { 구성 요소 }
`component.js` , `라인 1727`

static getPlayer (id) → { 플레이어 |미정의}
`video.js` , `라인 265`

정적 getPlayers () → {객체}
`video.js` , `249행`

static getPlugin (이름) → {function|undefined}
`plugin.js` , `438행`

static getPlugins (names opt ) → {Object|undefined}
`plugin.js` , `라인 407`

정적 getPluginVersion (이름) → {string}
`plugin.js` , `라인 431`

정적 getTech (이름) → { 기술 |정의되지 않음}
`tech/tech.js` , `라인 1051`

정적 isCrossOrigin (url, winLoc 선택 ) → {boolean}
`utils/url.js` , `라인 155`

정적 병합 옵션 (…소스) → {객체}
`utils/merge-options.js` , `24행`

정적 꺼짐 (요소, 유형 opt , fn opt )
`utils/events.js` , `라인 348`

정적 켜기 (요소, 유형, fn)
`utils/events.js` , `라인 262`

정적 항목 (요소, 유형, fn)
`utils/events.js` , `라인 487`

정적 parseUrl (url) → {url:URLObject}
`utils/url.js` , `43행`

정적 플러그인 (이름, 플러그인)
`video.js` , `393행`

static registerComponent (name, comp) → { 컴포넌트 }
`video.js` , `328행`

static registerPlugin (이름, 플러그인) → {function}
`plugin.js` , `346행`

정적 registerTech (이름, 기술)
`tech/tech.js` , `라인 1015`

정적 resetFormatTime ()
`utils/format-time.js` , `67행`

정적 setFormatTime (customImplementation)
`utils/format-time.js` , `60행`

정적 트리거 (요소, 이벤트, 해시 옵션 ) → {boolean|undefined}
`utils/events.js` , `라인 422`

정적 사용 (유형, 미들웨어)
`tech/middleware.js` , `46행`

정적 xhr (옵션) → {XMLHttpRequest|XDomainRequest}
`video.js` , `라인 459`