Skip to content

Commit d2d6484

Browse files
committed
update readme.md
1 parent 02563cf commit d2d6484

File tree

2 files changed

+18
-107
lines changed

2 files changed

+18
-107
lines changed

README.md

Lines changed: 18 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Feature
66

7-
Brightcove custom player using the Brightcove Player API.
7+
Brightcove custom player using the Brightcove Player API.
88
The official document is here. -> https://docs.brightcove.com/brightcove-player/current-release/Player.html
99

1010
<br>
@@ -19,7 +19,7 @@ The official document is here. -> https://docs.brightcove.com/brightcove-player/
1919

2020
- npm -> [https://www.npmjs.com/package/js-player-module-brightcove](https://www.npmjs.com/package/js-player-module-brightcove)
2121

22-
- Standalone(CDN) -> [https://cdn.jsdelivr.net/gh/yama-dev/js-player-module-brightcove@v5.0.0/dist/js-player-module-brightcove.js](https://cdn.jsdelivr.net/gh/yama-dev/js-player-module-brightcove@v5.0.0/dist/js-player-module-brightcove.js)
22+
- Standalone(CDN) -> [https://cdn.jsdelivr.net/gh/yama-dev/js-player-module-brightcove@v5.1.0/dist/js-player-module-brightcove.js](https://cdn.jsdelivr.net/gh/yama-dev/js-player-module-brightcove@v5.1.0/dist/js-player-module-brightcove.js)
2323

2424
- Zip -> [yama-dev/js-player-module-brightcove](https://github.com/yama-dev/js-player-module-brightcove/releases/latest)
2525

@@ -120,41 +120,25 @@ import PLAYER_MODULE_BRIGHTCOVE from 'js-player-module-brightcove';
120120

121121
### Default
122122

123-
| Parameter | Type | Default | Description |
124-
| :--- | :---: | :---: | :--- |
125-
| id | string | - ※省略不可 | プレーヤーを出力する要素のidを設定します。 |
126-
| videoid | string | - ※省略不可 | 動画のvideoidを設定します。 |
127-
| account | string | - ※省略不可 | BrightcovePlayerのaccountを設定します。 |
123+
| Parameter | Type | Default | Description |
124+
| :--- | :---: | :---: | :--- |
125+
| id | string | - ※省略不可 | プレーヤーを出力する要素のidを設定します。 |
126+
| videoid | string | - ※省略不可 | 動画のvideoidを設定します。 |
127+
| account | string | - ※省略不可 | BrightcovePlayerのaccountを設定します。 |
128128

129129
### Options
130130

131-
| Parameter | Type | Default | Description |
132-
| :--- | :---: | :---: | :--- |
133-
| playsinline | boolean | true | iOS10+でインライン再生をするかを指定します。<br>デフォルトでは、`playsinline`属性が設定され、インライン再生されます。<br>※`false`を指定するとiOS10+では全画面にプレーヤーが立ち上がります。 |
134-
| volume | number | 1 | 初期の音量を指定します。(0.0~1.0)<br>デフォルトでは、1(最大音量)がセットされます。<br>※機種、ブラウザに依存します。 |
135-
| ui_controls | boolean | false | `control`を表示するかしないかを指定します。<br>デフォルトでは、表示されません。 |
136-
| ui_default | boolean | true | ライブラリであらかじめ用意したUIパーツを表示するかしないかを指定します。<br>デフォルトは、表示されます。<br>※`false`を指定すると出力されません。 |
137-
| ui_default_css | boolean | true | ライブラリであらかじめ用意したCSSを出力するかしないかを指定します。<br>デフォルトは、CSSを出力します。<br>※`false`を指定すると出力されません。 |
138-
| ui_autoplay | boolean | false | 自動再生をするか指定します。<br>デフォルトでは、自動再生はされません。<br>※`true`を設定すると、動画のロードが完了すると自動再生を開始します。 |
139-
| stop_outfocus | boolean | false | フォーカスが外れた時に自動停止するか指定します。<br>デフォルトでは、自動停止しません。<br>※`true`を設定すると、フォーカスが外れた時にメディアが自動停止します。 |
140-
| mode | string | 'movie' | `'movie'` -> 動画モード<br>`'audio` -> 音声モード<br><br>デフォルトでは、動画モードになります。<br>動画か音声のみかを簡単に切り替えが出来ます。<br>※`'audio'`を設定すると、動画が表示されません。 |
141-
| poster | string | null | 動画のポスター画像を設定できます。<br>画像のパスを設定することで、サムネイルとして読み込まれます。 |
142-
143-
<br>
144-
145-
146-
## Browser support
147-
148-
| Browser | OS、version |
149-
| :--- | :--- |
150-
| Internet Explorer | 11+ |
151-
| Chrome | 最新 |
152-
| Firefox | 最新 |
153-
| Safari | 最新 |
154-
| Android | 4.4+ Chrome |
155-
| iOS | 8.0+ safari |
156-
157-
[Useble Browser version LIST -> Check More](./docs/device-check.md)
131+
| Parameter | Type | Default | Description |
132+
| :--- | :---: | :---: | :--- |
133+
| playsinline | boolean | true | iOS10+でインライン再生をするかを指定します。<br>デフォルトでは、`playsinline`属性が設定され、インライン再生されます。<br>※`false`を指定するとiOS10+では全画面にプレーヤーが立ち上がります。 |
134+
| volume | number | 1 | 初期の音量を指定します。(0.0~1.0)<br>デフォルトでは、1(最大音量)がセットされます。<br>※機種、ブラウザに依存します。 |
135+
| ui_controls | boolean | false | `control`を表示するかしないかを指定します。<br>デフォルトでは、表示されません。 |
136+
| ui_default | boolean | true | ライブラリであらかじめ用意したUIパーツを表示するかしないかを指定します。<br>デフォルトは、表示されます。<br>※`false`を指定すると出力されません。 |
137+
| ui_default_css | boolean | true | ライブラリであらかじめ用意したCSSを出力するかしないかを指定します。<br>デフォルトは、CSSを出力します。<br>※`false`を指定すると出力されません。 |
138+
| ui_autoplay | boolean | false | 自動再生をするか指定します。<br>デフォルトでは、自動再生はされません。<br>※`true`を設定すると、動画のロードが完了すると自動再生を開始します。 |
139+
| stop_outfocus | boolean | false | フォーカスが外れた時に自動停止するか指定します。<br>デフォルトでは、自動停止しません。<br>※`true`を設定すると、フォーカスが外れた時にメディアが自動停止します。 |
140+
| mode | string | 'movie' | `'movie'` -> 動画モード<br>`'audio` -> 音声モード<br><br>デフォルトでは、動画モードになります。<br>動画か音声のみかを簡単に切り替えが出来ます。<br>※`'audio'`を設定すると、動画が表示されません。 |
141+
| poster | string | null | 動画のポスター画像を設定できます。<br>画像のパスを設定することで、サムネイルとして読み込まれます。 |
158142

159143
<br>
160144

@@ -166,42 +150,6 @@ none
166150

167151
___
168152

169-
**For Developer**
170-
171-
## Contribution
172-
173-
1. Fork it ( https://github.com/yama-dev/js-player-module-brightcove/fork )
174-
2. Create your feature branch (git checkout -b my-new-feature)
175-
3. Commit your changes (git commit -am 'Add some feature')
176-
4. Push to the branch (git push origin my-new-feature)
177-
5. Create new Pull Request
178-
179-
<br>
180-
181-
## Develop
182-
183-
### at Development
184-
185-
Install node modules.
186-
187-
``` bash
188-
$ npm install
189-
```
190-
191-
Run npm script 'develop'
192-
193-
``` bash
194-
$ npm run develop
195-
```
196-
197-
Run npm script 'production'
198-
199-
``` bash
200-
$ npm run production
201-
```
202-
203-
<br>
204-
205153
## Licence
206154

207155
[MIT](https://github.com/yama-dev/js-player-module-brightcove/blob/master/LICENSE)

docs/device-check.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)