恒星播放器 - 插件手册

事件

播放器通过事件调用插件中实现的相应方法，有两种类型的事件：

  1. 播放器事件
  2. 控件事件

播放器事件

由播放器的状态等发生变化时触发的事件，如开始播放、暂停等。 事件定义为插件对象的成员方法，由播放器在相应情况下调用。

插件启动

start

插件成功初始化后会触发启动事件，注意插件启动并不意味用户点击了插件，此时插件在后台运行。 插件如果是随播放器启动，则在播放器启动过程中会触发插件的 start 事件， 如果插件是手动启用或者刚安装，也会触发 start 事件。 可以在此事件中进行一些插件初始化相关的操作。

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def start(self):      
        return super().start()
1
2
3

插件停止

stop

插件退出或被禁用时会触发插件的 stop 事件

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def stop(self):      
        return super().stop()
1
2
3

显示

show

当用户在主界面或者插件菜单中调用插件时，会触发插件的 show 事件。 一般在 show 事件中显示插件界面。

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def show(self):
        controls = [    
            {'type':'label','name':'text', 'height': 40},
            {'type':'webview','value':'https://www.stellarplayer.com/blog/'}
        ]
        self.doModal('main',600, 500,'测试', controls)
1
2
3
4
5
6
7

播放

onPlay

当开始播放视频时触发此事件

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def onPlay(self, url):  
        # url 当前播放的视频地址
        ...
1
2
3
4

停止播放

onStopPlay

当停止播放视频时触发此事件

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def onStopPlay(self, watchTime):  
        # watchTime 观看时长
        ...
1
2
3
4

暂停 / 继续播放

onPause

当暂停或者继续播放视频时触发此事件

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def onPause(self, play):  
        # play=0 暂停; play=1 继续
        ...
1
2
3
4

画面渲染

onVideoRendered

当视频画面渲染每帧都会触发此事件，可以在该事件中进行动画绘图操作 绘图相关 API 请参见 [API]

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def onVideoRendered(self, pts, viewWidth, viewHeight, frameWidth, frameHeight):  
        # pts 为当前画面时间，单位毫秒  
        # viewWidth, viewHeight 视频窗口尺寸
        # frameWidth, frameHeight 视频画面尺寸
        ...
1
2
3
4
5
6

对话框创建成功后

onModalCreated

当插件调用 doModal 创建窗口成功后，会调用此回调

地址解析 异步

onUrlInput

当用户打开 Url 地址失败时，会触发此事件。 可以在事件响应方法中通过 player.dispatchResult 异步返回 url 的解析结果。

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def onUrlInput(self, dispatchId, url):
        # url 为播放器打开失败的 url
        print(url)
        ...
        self.player.dispatchResult(dispatchId, url=url, result=result)
1
2
3
4
5
6

result 形如：

{
    'src': ['http://test.com/1.m3u8'],
    'size': 123456,
    'headers': {
        'referer': 'http://test.com/'
    },
    'title': '测试视频'
}
1
2
3
4
5
6
7
8

其中：

  • src 视频地址列表，如果有多项说明视频有多个文件拼接而成
  • size 视频总大小
  • headers 视频 http 请求头
  • title 视频标题

播放器搜索 异步

onPlayerSearch

当用户在播放器中搜索时，会触发此事件。 可以在事件响应方法中通过 player.dispatchResult 异步返回搜索结果。

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def onPlayerSearch(self, dispatchId, searchId, wd, limit):
        ...
        self.player.dispatchResult(dispatchId, result=result)
1
2
3
4

参数:

  • dispatchId 异步调用 id，由 dispatchAsync 自动附加
  • searchId 搜索 id，由业务层维护，用于区分多次搜索和相应结果
  • wd 用户搜索的关键字
  • limit 当查询到了 limit 条结果后返回（可能会超出 limit 条）, 负数表示不限制（导致查询慢）

result 形如：

[
    {
        "name": "黑客帝国动画版",
        "pic": "https://img.52swat.cn/upload/vod/20200728-14/34603be8a26edd9c5d041d1bb818e6af.jpg",
        "summary": "《黑客帝国动画版》由9段以《黑客帝国》系列电影世界观为基础生发出的短片组成",
        "pub_date": "2003-06-03",
        "urls": [
            [
                "高清",
                "https://vod1.bdzybf1.com/20200630/xK2VjVfi/index.m3u8"
            ]
        ]
    },
    ...
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

其中：

  • name 结果名称
  • pic 结果图片
  • summary 文字描述
  • pub_date 影片发布日期
  • urls 影片地址，可能返回多个文件，按数组返回，数组中每个元素格式为（文件名称，文件地址）

控件事件

控件事件指的是当用户操作了插件中的控件时触发的事件，比如点击按钮等。

点击

onClick

当用户点击了按钮控件时触发，默认会调用插件下的 onClick 方法

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def onClick(self, control):
        # control 为被点击的控件名称，用于业务区分
        print(control)
1
2
3
4

也可以在创建控件时使用 @click 的缩写，将点击事件映射到插件对象的特定成员方法上：

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def show(self):
        controls = [
            {
                'type':'button',
                'name':'btn',
                'height': 40, 
                'width': 200, 
                'textColor': '#ffffff', 
                'fontSize': 20,
                'value': 1,
                'matchParent': True,
                '@click': 'on_hello'
            },
            {'type':'space'}
        ]

        self.doModal('main',800, 600,'测试', controls)    

    def on_hello(self, *a, **k):        
        print('hello')
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

输入框输入

onEditInput

当用户在输入框中输入时，会触发此事件，可以在此事件中进行即时搜索类似操作。

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def onEditInput(self, page, control, value):
        # page 对话框名称
        # control 触发 onEditInput 事件的控件名称
        # value 输入框文字
        print(control)
1
2
3
4
5
6

也可以在创建控件时使用 @input 的缩写，将点击事件映射到插件对象的特定成员方法上：

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def show(self):
        controls = [    
            {'type':'edit','name':'text', 'height': 40, '@input': 'on_hello'},
            {'type':'space'}
        ]
        self.doModal('main',600, 500,'测试', controls)

    def on_hello(self, page, control, value):
        # page 对话框名称
        # control 触发 onEditInput 事件的控件名称
        # value 输入框文字
        print(value)
1
2
3
4
5
6
7
8
9
10
11
12
13

列表项双击

onListItemDblClick

当用户双击列表项时，会触发此事件。

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def show(self):
        itemlayout = [
        [
            {
                'type':'image',
                'name':'image',
                'height': 30, 
                'width': 30
            },
            {
                'type': 'space',
                'width': 8
            },
            {
                'type':'label',
                'name':'desp',
                'textColor': '#000000', 
                'fontSize': 15,
                'width': 100
            }
        ]
    ]
    value = [
        {
            'image': 'https://static.coldlake1.com/staticsource/website-master/assets/app-logo.5379c2ba.png',
            'desp': 'item1'
        },
        {
            'image': 'https://static.coldlake1.com/staticsource/website-master/assets/app-logo.5379c2ba.png',
            'desp': 'item2'
        }
    ]
    controls = [
        {
            'type':'list',
            'name':'list',
            'itemheight': 30, 
            'itemlayout': itemlayout,
            'height': 200,
            'value': value,
        },
        {'type':'space'}
    ]
        self.doModal('main',600, 500,'测试', controls)

    def onListItemDblClick(self, page, control, item):
        # page 对话框名称
        # control 触发事件的控件名称
        # item 双击的 item 序号
        print(f'onListItemClick, {control=},{item=}')
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

网格 grid 中的元素被双击时也会触发此事件。

此事件也可通过 @dblclick 绑定到指定的方法上

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def show(self):
        itemlayout = [
        [
            {
                'type':'image',
                'name':'image',
                'height': 30, 
                'width': 30
            },
            {
                'type': 'space',
                'width': 8
            },
            {
                'type':'label',
                'name':'desp',
                'textColor': '#000000', 
                'fontSize': 15,
                'width': 100
            }
        ]
    ]
    value = [
        {
            'image': 'https://static.coldlake1.com/staticsource/website-master/assets/app-logo.5379c2ba.png',
            'desp': 'item1'
        },
        {
            'image': 'https://static.coldlake1.com/staticsource/website-master/assets/app-logo.5379c2ba.png',
            'desp': 'item2'
        }
    ]
    controls = [
        {
            'type':'list',
            'name':'list',
            'itemheight': 30, 
            'itemlayout': itemlayout,
            'height': 200,
            'value': value,
            '@dblclick': 'on_hello'
        },
        {'type':'space'}
    ]
        self.doModal('main',600, 500,'测试', controls)

    def on_hello(self, page, control, item):
        # page 对话框名称
        # control 触发事件的控件名称
        # item 双击的 item 序号
        print(f'onListItemClick, {control=},{item=}')
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

列表控件点击

onListItemControlClick

当用户点击了列表项目中的控件时（比如按钮），会触发此事件

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def show(self):
        itemlayout = [
            [
                {
                    'type':'image',
                    'name':'image',
                    'height': 30, 
                    'width': 30
                },
                {
                    'type': 'space',
                    'width': 8
                },
                {
                    'type':'button',
                    'name':'desp',
                    'textColor': '#000000', 
                    'fontSize': 15,
                    'width': 100
                }
            ]
        ]
        value = [
            {
                'image': 'https://static.coldlake1.com/staticsource/website-master/assets/app-logo.5379c2ba.png',
                'desp': 'item1'
            },
            {
                'image': 'https://static.coldlake1.com/staticsource/website-master/assets/app-logo.5379c2ba.png',
                'desp': 'item2'
            }
        ]
        controls = [
            {
                'type':'list',
                'name':'list',
                'itemheight': 30, 
                'itemlayout': itemlayout,
                'height': 200,
                'value': value,
            },
            {'type':'space'}
        ]
        self.doModal('main',600, 500,'测试', controls)

    def onListItemControlClick(self, page, listControl, item, itemControl):
        # page 对话框名称
        # listControl 触发事件的控件名称
        # item 双击的 item 序号
        # itemControl 点击的控件名称
        print(f'onListItemControlClick,{page=},{listControl=},{item=},{itemControl=}')
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

此事件也可通过 @click 绑定到指定的方法上，注意 @click 要定义在 layout 上

class myplugin(StellarPlayer.IStellarPlayerPlugin):
    def show(self):
        itemlayout = [
            [
                {
                    'type':'image',
                    'name':'image',
                    'height': 30, 
                    'width': 30,
                    '@click': 'on_hello'
                },
                {
                    'type': 'space',
                    'width': 8
                },
                {
                    'type':'button',
                    'name':'desp',
                    'textColor': '#000000', 
                    'fontSize': 15,
                    'width': 100
                }
            ]
        ]
        value = [
            {
                'image': 'https://static.coldlake1.com/staticsource/website-master/assets/app-logo.5379c2ba.png',
                'desp': 'item1'
            },
            {
                'image': 'https://static.coldlake1.com/staticsource/website-master/assets/app-logo.5379c2ba.png',
                'desp': 'item2'
            }
        ]
        controls = [
            {
                'type':'list',
                'name':'list',
                'itemheight': 30, 
                'itemlayout': itemlayout,
                'height': 200,
                'value': value,
            },
            {'type':'space'}
        ]
        self.doModal('main',600, 500,'测试', controls)

    def on_hello(self, page, listControl, item, itemControl):
        # page 对话框名称
        # listControl 触发事件的控件名称
        # item 双击的 item 序号
        # itemControl 点击的控件名称
        print(f'onListItemControlClick,{page=},{listControl=},{item=},{itemControl=}')
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53