Commit fa18c1b5 authored by Dima's avatar Dima

Update Teleport guide_RU.md

parent 5c21194d
......@@ -26,7 +26,7 @@ Teleport совместим с любыми CAS/DRM системами, но т
# Интеграция
## Валидация домена
Помделовательность действий:
Последовательность действий:
1. Необходимо зарегистрироваться на https://cabinet.teleport.media
2. В разделе "Интеграция" пройти процедуру валидации домена любым удобным из указанных способов..
3. После подтверждения домена, во вкладке "My domains" вы получите API ключи для работы скрипта.
......@@ -59,7 +59,7 @@ $ index.html
debug: true, // { boolean }
//Настройка отображения системных сообщений teleport.js в консоль, доступ к глобальным объектам.
// teleport группирует пиров по ссылке на манифест
// В случае если вы используете разные сервера для раздачи манифеста
// В случае если вы используете разные сервера для раздачи манифеста,
// передайте в значение параметра функцию, которая приводит ссылку на манифест
// с разных url адресов к одинаковому виду
manifestUrlFormatter: (manifestLink) => { //default value
......@@ -84,10 +84,12 @@ $ index.html
Для получения обратной связи от teleport.js в режиме реального времени необходимо подписаться на события генерируемые в методе window.teleport.events. Он принимает следующие параметры:
**eventName** (string) — название евента API
**callback** (function) — функция, в которую будет передан полученный результат после выполнения евента.
| Параметр | Описание |
| ------------- | ------------- |
| **eventName** (string) | название события API |
| **callback** (function) | функция, в которую будет передан полученный результат после выполнения события. |
*Пример:*
```html
$ skeleton
<script>
......@@ -99,64 +101,58 @@ $ Для ограничения доступа к медиаконтенту н
только после авторизации.
```
#### События
Event Name: **noWebrtc**
Arguments: *number* **performance.now()**
Браузер не поддерживает webrtc.
#### Список событий:
| Event Name | Arguments | Description |
| ------------- | ------------- | ------------- |
| **noWebrtc** | *number* **performance.now()** |Браузер не поддерживает webrtc. |
*Пример:*
```javascript
window.teleport.events.on('noWebrtc',(date) => console.log('change your IE', date))
```
Event Name: **peerConnected**
Arguments: *string* **userId**, *number* **performance.now()**
Установлено WebRTC соединение. userId - уникальный Id пира.
------------
| Event Name | Arguments | Description |
| ------------- | ------------- | ------------- |
| **peerConnected**| *string* **userId**, *number* **performance.now()** |Установлено WebRTC соединение. userId - уникальный Id пира.|
*Пример:*
```javascript
window.teleport.events.on('peerConnected', (userId, date) => console.log('New peer connected.', userId, date))
```
Event Name: **peerDisconnected**
Arguments: *string* **userId**, *number* **performance.now()**
WebRTC соединение разорвано.
------------
| Event Name | Arguments | Description |
| ------------- | ------------- | ------------- |
| **peerDisconnected**| *string* **userId**, *number* **performance.now()** |WebRTC соединение разорвано. |
*Пример:*
```javascript
window.teleport.events.on('peerDisconnected', (userId, date) => console.log('peerDisconnected', userId, date))
```
------------
Event Name: **statSegment**
Arguments: *string* **targetId**('cdn' | PeerTargetId), *string* **segmentId**, *int* **byteLength**, *int* **loadTime**, *number* **performance.now()**
Загружен сегмент видео файла. Если сегмент загружен из CDN targetId === 'cdn'.
| Event Name | Arguments | Description |
| ------------- | ------------- | ------------- |
| **statSegment**| *string* **targetId**('cdn'/ PeerTargetId), *string* **segmentId**, *int* **byteLength**, *int* **loadTime**, *number* **performance.now()**|Загружен сегмент видео файла. Если сегмент загружен из CDN targetId === 'cdn'. |
*Пример:*
```javascript
window.teleport.events.on('statSegment', (targetId, segmentId, byteLength, loadTime, date) => console.log('New segment loaded:', segmentId))
```
#### Методы
**window.teleport.api.getSegment(url:String, quality:number, callback?:(Promise<res>)=>void):Promise** - выполняет запрос сегмента. url - Url сегмента. quality - id качества сегмента.
**window.teleport.api.getSegmentIdByUrl(url: string):string** - возвращает уникальный идентификатора сегмента по URL.
#### Список методов:
**window.teleport.api.abort(url: string, callback?:()=>void):void** - отменяет запрос сегмента. url - URL сегмента.
**window.teleport.api.buffering(): void** - сообщает на сервер телепорта о событии буферизации.
**window.teleport.api.setUploadState(true|false): void** - включает/Выключает отдачу сегментов в пиринг. Статус текущего состояния можно узнать в свойстве uploadState метода getStats.
**window.teleport.api.segmentInfo(url|segmentId, callback?:()=>void): string** - возвращает источник загрузки сегмента ('cdn' | targetId | 'Segment not loaded')
| Event Name | Arguments |
| ------------- | ------------- |
| **window.teleport.api.getSegment(url:String, quality:number, callback?:(Promise<res>)=>void):Promise** |выполняет запрос сегмента. url - Url сегмента. quality - id качества сегмента. |
| **window.teleport.api.getSegmentIdByUrl(url: string):string** | возвращает уникальный идентификатора сегмента по URL. |
| **window.teleport.api.abort(url: string, callback?:()=>void):void**|отменяет запрос сегмента. url - URL сегмента.|
| **window.teleport.api.buffering(): void**|сообщает на сервер Teleport о событии буферизации.|
| **window.teleport.api.setUploadState(true/false): void**|включает/выключает отдачу сегментов в пиринг. Статус текущего состояния можно узнать в свойстве uploadState метода getStats.|
|**window.teleport.api.segmentInfo(url/segmentId, callback?:()=>void): string**| возвращает источник загрузки сегмента ('cdn' / targetId / 'Segment not loaded')|
*Пример:*
```javascript
$ javascript
...
......@@ -169,9 +165,14 @@ $ console output example
"facfdb535ac9500c"
"Segment not loaded"
```
------------
**window.teleport.api.getStats (): Object** отдает агрегированную статистику по загруженым сегментам с медиа сервера и из пиринговой сети.
| Event Name | Arguments |
| ------------- | ------------- |
|**window.teleport.api.getStats (): Object**| отдает агрегированную статистику по загруженым сегментам с медиа сервера и из пиринговой сети.|
*Пример:*
```javascript
$ javascript
...
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment