서문
이 항목에서는 Playback API에서 데이터를 검색하고 Brightcove Player 용 오버레이에 표시하는 방법을 알아 봅니다. 이 오버레이는 재생이 일시 중지되거나 종료될 때 계정에서 태그/메타데이터를 통해 관련 동영상 세트를 표시합니다. 또한 참조 CMS API 버전이 샘플의.
제한 사항
플레이어 예제
이 예제에서는 재생이 일시 중지되거나 종료된 경우 관련 비디오 축소판의 대화형 오버레이를 표시합니다. 아래 비디오의 재생을 시작하십시오. 재생을 일시 중지하거나 비디오가 종료되면 관련 비디오의 오버레이가 나타납니다.
펜보기 18485 관련 동영상 태그 재생 API게시자 : Brightcove Learning Services ( 쫑끼리 ) 의 위에 CodePen .
소스 코드
보기 GitHub의 완벽한 솔루션 .
개요
이 샘플은 Playback API를 호출하고 동일한 계정에서 플레이어에로드 된 동영상과 동일한 태그 값을 가진 관련 동영상을 검색합니다. 이러한 관련 비디오는 비디오 재생이 일시 중지되거나 종료 될 때 오버레이에 대화 형 미리보기 이미지로 표시됩니다. 오버레이에서 썸네일을 선택하면 플레이어에서 연결된 비디오가 로드되고 재생이 시작됩니다.
Playback API를 처음 사용하는 경우 다음 문서를 검토하여 시작하십시오.
코드펜 사용
위의 CodePen을 효과적으로 사용하기위한 몇 가지 팁은 다음과 같습니다.
- Result버튼을 클릭하여 플레이어의 실제 표시를 토글합니다.
- HTML/CSS/JS버튼을 클릭하여 코드 유형 중 하나를 표시합니다.
- 이 문서의 뒷부분에서 응용 프로그램에 사용되는 논리, 흐름 및 스타일링에 대해서는Player/HTML 구성 , 응용 프로그램 흐름 및 응용 프로그램스타일 지정섹션에서 설명합니다. 이러한 섹션의 정보와 함께 따르는 가장 좋은 방법은 다음과 같습니다.
- CodePen에서EDIT ON CODEPEN버튼을 클릭하고 하나의 브라우저/브라우저 탭에서 코드를 사용할 수 있습니다.
- CodePen에서 표시할 코드를 조정합니다. CodePen 내에서 다른 코드 섹션의 너비를 변경할 수 있습니다.
- 다른 브라우저/브라우저 탭에서플레이어/HTML 구성 , 응용 프로그램 흐름및/또는 응용 프로그램 스타일 지정섹션을 봅니다. 이제 코드 설명을 따라 동시에 코드를 볼 수 있습니다.
개발 순서
다음은 권장되는 개발 순서입니다.
- In-Page 임베드 플레이어 구현을 사용하여 플레이어, 플러그인 및 CSS의 기능을 테스트합니다 (CSS가 필요한 경우).
- 로컬 테스트를 위해 플러그인의 자바 스크립트와 CSS를 별도의 파일에 넣으십시오.
- 오류가 발생하면 플러그인 코드와 CSS를 서버에 배포하십시오.
- Studio를 사용하여 플레이어에 플러그인과 CSS를 추가합니다.
- iframe 구현이 더 적합하다고 판단되면 In-Page 내장 플레이어 구현을 교체하십시오 (다음 섹션에서 자세히 설명).
이러한 단계에 대한 자세한 내용은단계별 단계를 검토하십시오. 플러그인 개발가이드.
iframe 또는 페이지 내 포함
브라이트코브 플레이어에서 향상된 기능을 개발할 때 코드가 iframe 또는 In-Page embed 구현에 가장 적합한지 결정해야 합니다. 가장 좋은 방법은 iframe 구현과 함께 사용할 플러그인을 작성하는 것입니다. iframe 플레이어를 사용하면 다음과 같은 이점이 있습니다.
- 기존 자바 스크립트 및/또는 CSS와의 충돌 없음
- 자동 응답성
- iframe은 소셜 미디어 앱에서 쉽게 사용할 수 있습니다 (또는 동영상이 다른 앱으로 “이동”해야 할 때마다).
In-Page 임베드 플레이어를 통합하는 것이 더 복잡할 수 있지만 해당 구현을 중심으로 코드를 계획할 때가 있습니다. 일반화하려면이 방법은 포함 된 페이지가 플레이어와 통신해야 할 때 가장 좋습니다. 특히 다음은 몇 가지 예입니다.
- 포함 페이지의 코드는 플레이어 이벤트를 수신하고 이에 대한 조치를 취해야 합니다.
- 플레이어는 포함 된 페이지의 스타일을 사용합니다.
- iframe으로 인해 포함 된 페이지의 리디렉션처럼 앱 로직이 실패합니다.
최종 구현에서 iframe 코드를 사용하지 않더라도 JavaScript 용 플러그인과 CSS용 별도의 파일과 함께 In-Page embed 코드를 사용할 수 있습니다. 이렇게 하면 로직을 캡슐화하여 여러 플레이어에서 쉽게 사용할 수 있습니다.
사용된 API/플러그인 리소스
| API 메소드 | API 이벤트 | API 등록 정보 |
|---|---|---|
| 플레이 () | 로드된 메타데이터 | mediainfo.account_id |
| 카탈로그.load () | mediainfo.tags [0] | |
| 카탈로그.get비디오 () | 미디어포.이름 |
플레이어/HTML 구성
오버레이 플러그인은이 예제의 JavaScript 코드에서 정의되고 초기화됩니다. 여기에서 수행되는 이유는 오버레이를 초기화하기 전에 관련 비디오 메타 데이터를 가져와야하기 때문입니다.
플레이어 구성에 오버레이 플러그인을 포함하려는 경우 비디오 클라우드 스튜디오의 플레이어 모듈에 오버레이 자바스크립트 및 CSS 파일을 추가할 수 있습니다. 플러그인섹션에서Name속성을 비워 두면 코드 내에서 플러그인을 초기화할 수 있습니다.
기타 HTML
추가하는 것을 잊지 마십시오id속성video플레이어 소스 코드의 태그.
<video-js id="myPlayerID"
...
응용 프로그램 흐름
이 응용 프로그램의 기본 논리는 다음과 같습니다.
- 기본 재생 API URL 및 정책 키의 값을 정의하는 변수를 만듭니다.
- 비디오 메타데이터를 검색하기 위해 비디오가 로드되기 시작할 때까지 기다립니다.
- Playback API에 대한 요청을 설정합니다.
- Playback API에 요청하여 처음 9 개의 관련 동영상을 가져옵니다.
- 오버레이 내용의 서식을 지정하여 각 관련 비디오의 축소판을 표시합니다.
- 사용자가 관련 비디오 축소판 중 하나를 선택한 다음 플레이어로 로드하고 재생을 시작합니다.
값 정의
기본 재생 API URL 및 정책 키의 값을 정의하는 변수를 만듭니다.
로드된 메타데이터 대기
라벨이 붙은 코드를 찾으십시오:
// +++ Wait for loadedmetadata +++
loadedmetadata이벤트를 수신하여 비디오가 로드되기 시작할 때까지 기다립니다. 이렇게 하면mediainfo객체 내에서 계정 ID, 이름 및 태그 값과 같은 비디오 메타데이터를 사용할 수 있습니다.
API 요청 설정
라벨이 붙은 코드를 찾으십시오:
// +++ Setup the API request +++
현재 플레이어에로드 된 동영상의 정보를 사용하여 동일한 계정의 동영상에 대한 Playback API 검색 요청을 만듭니다. 검색은 현재 비디오의 첫 번째 태그와 동일한 값을 가진 비디오를 찾습니다. 현재 동영상과 이름이 같은 동영상은 제외되며 반환되는 동영상 수는 9개로 제한됩니다. 그것이 얼마나 많은 오버레이 레이아웃에 들어갈 것인가입니다.
Playback API 요청하기
라벨이 붙은 코드를 찾으십시오:
// +++ Make the Playback API request +++
Playback API RESTful 웹 서비스에 HTTP GET 요청을 보냅니다. 반환 된 데이터를 JSON 형식으로 구문 분석합니다. 오류가 발생하면 오류 메시지를 표시합니다.
오버레이 컨텐츠 서식 지정
라벨이 붙은 코드를 찾으십시오:
// +++ Format the overlay content +++
오버레이 내용의 서식을 지정하려면 다음을 수행합니다.
- Playback API에서 반환 된 각 관련 동영상의 ID, 이름 및 미리보기 이미지를 추출하여 배열에 저장합니다.
- 관련 비디오 배열을 반복하여 각 관련 비디오에 대한
<div>요소를 보유하는 비디오 목록<div>래퍼를 만듭니다. 이것은 오버레이 콘텐츠가 될 것입니다. - 새로 생성 된 관련 비디오 콘텐츠로 오버레이 플러그인을 초기화하십시오. 오버레이가 표시되면 관련 비디오 축소판 그리드가 표시됩니다. 비디오 재생이 일시 중지되거나 종료되었을 때 오버레이를 표시합니다. 기본 비디오가 재생 중일 때 오버레이를 숨깁니다.
관련 비디오 로드 및 재생
라벨이 붙은 코드를 찾으십시오:
// +++ Load and play related video +++
사용자가 선택한 관련 비디오의 재생을 로드하고 시작하는 함수를 만듭니다.
응용 프로그램 스타일 지정
CSS는 오버레이에 대한 관련 비디오 축소판 격자 스타일을 지정합니다.
플러그인 코드
일반적으로 JavaScript를 브라이트코브 플레이어 플러그인으로 변환할 때 명목상의 변경이 필요합니다. 필요한 변경 사항 중 하나는ready()메소드의 표준 사용을 플러그인을 정의하는 코드로 대체하는 것입니다.
다음은 플레이어와 함께 작동하는 자바 스크립트 코드에 매우 일반적으로 사용되는 시작이다:
videojs.getPlayer('myPlayerID').ready(function() {
var myPlayer = this;
...
});
첫 번째 줄을 변경하여 표준 구문을 사용하여 브라이트코브 플레이어 플러그인을 시작합니다.
videojs.registerPlugin('pluginName', function(options) {
var myPlayer = this;
...
});
앞서 언급했듯이이 문서의 해당 GitHub 저장소에서 플러그인의 JavaScript 코드를 볼 수 있습니다. related-videos.js .
플레이어와 플러그인 사용하기
플러그인의 CSS 및 JavaScript 파일이 인터넷 액세스 가능 위치에 저장되어 있으면 플레이어와 함께 플러그인을 사용할 수 있습니다. Studio의 플레이어 모듈에서플레이어를선택한 다음Plugins섹션에서 CSS 및 JavaScript 파일에 URL을 추가하고 옵션이 필요한 경우이름및옵션을추가 할 수 있습니다.