3.0.20 • Published 9 months ago

xgplayer-subtitles v3.0.20

Weekly downloads
175
License
MIT
Repository
-
Last release
9 months ago

Introduction

外挂字幕组件,目前支持vtt格式的解析

Start

  1. Install

    $ npm install xgplayer-subtitles
  2. Usage

    Step 1:

    <div id="vs"></div>

    Step 2:

    import Player from 'xgplayer';
    
    const player = new Player({
        id: 'vs',
        url: ''
    })
    
    const options = {
       player: player, // 可选, 如果初始化的时候已经有播放器实例
       subTitles: [{              //必选 字幕信息
         label: '中文',
         language : '',          //必选
         id: 'cn',               //必选
         isDefault: false,       //必选 是否是默认字幕
         url: './subtitle/cn.vtt' //必选 字幕链接地址
        }, {
          label: '英文',
          url: './subtitle/en.vtt',
          id: 'en',
          isDefault: true,
          language: 'en'
        }],
        defaultOpen: false, // 是否默认开启字幕
        mode: 'bg', //可选 字幕显示模式,支持bg(背景)和 stroke(字体边框填充),默认stroke
        line: 'double' //可选 字幕最大显示行数 默认单行,single, 支持single/double/three,
      }
    const subTitle = new window.XgSubtitle(options)
    // 如果在初始化的时候播放器还没有播放器实例,也可以使用以下挂载播放器
    
    subTitle.attachPlayer(player)

API

atttchPlayer(player)

挂载播放器实例

detachPlayer(player)

卸载播放器实例

desttroy

销毁组件

switch({id:'', language:''})

切换字幕

subtitle.switch({id: 'cn'}).then(() => {
    console.log('切换成功')
}).catch(() => {
    console.log('切换失败')
})

切换信息返回说明

{
    code: 0, // 切换成功
    msg: 'SUCCESS'
},{
    code: 1, // 下载错误
    msg: 'LOAD_ERROR'
}, {
    code: 2, // 解析错误
    msg: 'PARSER_ERROR'
}, {
    code: 3,  // 格式不支持
    msg: 'FORMAT_NOT_SUPPORTED'
},
{
    code: 4, // id或者语言不存在
    msg: 'ID_OR_LANGUAGE_NOT_EXIST'
}, {
    code: 5, // 参数错误
    msg: 'PARAMETERS_ERROR'
}, {
    code: 6, // 操作中断
    msg: 'ABORT'
}, {
    code: 7, // 未知错误
    msg: 'UNKNOWN'
}

openOff()

关闭当前字幕

错误码说明

3.0.21-rc.7

9 months ago

3.0.21-rc.4

10 months ago

3.0.21-rc.5

9 months ago

3.0.21-rc.2

11 months ago

3.0.21-rc.3

10 months ago

3.0.18-rc.3

1 year ago

3.0.20-rc.2

12 months ago

3.0.20-rc.1

12 months ago

3.0.20-rc.0

12 months ago

3.0.20-rc.6

11 months ago

3.0.20-rc.5

11 months ago

3.0.20-rc.4

11 months ago

3.0.20-rc.3

11 months ago

3.0.19-alpha.0

1 year ago

3.0.20-rc.8

11 months ago

3.0.20-rc.7

11 months ago

3.0.21-rc.0

11 months ago

3.0.19-rc.9

1 year ago

3.0.21-rc.1

11 months ago

3.0.19-rc.10

12 months ago

3.0.19-rc.7

1 year ago

3.0.19-rc.8

1 year ago

3.0.19-rc.5

1 year ago

3.0.19-rc.6

1 year ago

3.0.19-rc.3

1 year ago

3.0.19-rc.4

1 year ago

3.0.19-rc.1

1 year ago

3.0.19-rc.2

1 year ago

3.0.19-rc.0

1 year ago

3.0.20

11 months ago

3.0.18

1 year ago

3.0.19

12 months ago

3.0.18-rc.2

1 year ago

3.0.18-rc.1

1 year ago

3.0.18-rc.0

1 year ago

3.0.17

1 year ago

3.0.17-rc.4

1 year ago

3.0.17-rc.3

1 year ago

3.0.17-rc.2

1 year ago

3.0.17-rc.1

1 year ago

3.0.17-rc.0

1 year ago

3.0.17-alpha.0

1 year ago

3.0.16

1 year ago

3.0.15

1 year ago

3.0.15-alpha.3

1 year ago

3.0.15-alpha.2

1 year ago

3.0.15-alpha.1

1 year ago

3.0.15-alpha.0

1 year ago

3.0.14

1 year ago

3.0.14-alpha.2

1 year ago

3.0.14-alpha.1

1 year ago

3.0.14-alpha.0

1 year ago

3.0.13

1 year ago

3.0.12

1 year ago

3.0.12-alpha.7

1 year ago

3.0.12-alpha.6

1 year ago

3.0.12-alpha.5

2 years ago

3.0.12-alpha.4

2 years ago

3.0.12-alpha.3

2 years ago

3.0.12-alpha.2

2 years ago

3.0.12-alpha.1

2 years ago

3.0.12-alpha.0

2 years ago

3.0.11

2 years ago

3.0.11-alpha.11

2 years ago

3.0.11-alpha.10

2 years ago

3.0.11-alpha.9

2 years ago

3.0.10

2 years ago

3.0.10-alpha.0

2 years ago

3.0.10-alpha.4

2 years ago

3.0.10-alpha.3

2 years ago

3.0.10-alpha.2

2 years ago

3.0.10-alpha.1

2 years ago

3.0.10-alpha.8

2 years ago

3.0.10-alpha.6

2 years ago

3.0.10-alpha.5

2 years ago

3.0.11-alpha.8

2 years ago

3.0.11-alpha.6

2 years ago

3.0.11-alpha.7

2 years ago

3.0.11-alpha.4

2 years ago

3.0.11-alpha.5

2 years ago

3.0.11-alpha.2

2 years ago

3.0.11-alpha.3

2 years ago

3.0.11-alpha.0

2 years ago

3.0.11-alpha.1

2 years ago

3.0.4

2 years ago

3.0.3

2 years ago

3.0.9-alpha.0

2 years ago

3.0.9-alpha.2

2 years ago

3.0.8

2 years ago

3.0.9-alpha.1

2 years ago

3.0.7

2 years ago

3.0.6

2 years ago

3.0.9-alpha.3

2 years ago

3.0.5

2 years ago

3.0.7-alpha.1

2 years ago

3.0.7-alpha.2

2 years ago

3.0.7-alpha.0

2 years ago

3.0.7-alpha.3

2 years ago

3.0.5-alpha.0

2 years ago

3.0.5-alpha.2

2 years ago

3.0.5-alpha.1

2 years ago

3.0.9

2 years ago

3.0.8-alpha.4

2 years ago

3.0.8-alpha.5

2 years ago

3.0.8-alpha.2

2 years ago

3.0.8-alpha.3

2 years ago

3.0.8-alpha.1

2 years ago

3.0.6-alpha.6

2 years ago

3.0.6-alpha.5

2 years ago

3.0.6-alpha.4

2 years ago

3.0.6-alpha.3

2 years ago

3.0.6-alpha.2

2 years ago

3.0.8-alpha.6

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

3.0.3-alpha.1

2 years ago

3.0.3-alpha.2

2 years ago

3.0.3-alpha.3

2 years ago

1.0.24

2 years ago

1.0.23

2 years ago

1.1.0-alpha.1

2 years ago

1.1.0-alpha.2

2 years ago

1.1.0-alpha.0

2 years ago

1.0.23-alpha.0

3 years ago

1.0.22

4 years ago

1.0.19

4 years ago

1.0.18

4 years ago

1.0.17

4 years ago

1.0.17-alpha.1

4 years ago

1.0.17-alpha.0

4 years ago

1.0.21

4 years ago

1.0.20-alpha.0

4 years ago

1.0.20

4 years ago

1.0.21-alpha.0

4 years ago

1.0.16

4 years ago

1.0.15

4 years ago

1.0.15-alpha.2

4 years ago

1.0.14

4 years ago

1.0.13

4 years ago

1.0.11

4 years ago

1.0.12

4 years ago

1.0.10

4 years ago

1.0.9

4 years ago

1.0.9-alpha.1

4 years ago

1.0.9-alpha.0

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.2

4 years ago