BBASMLivePlugin.h 8.39 KB
//
//  BBASMLivePlugin.h
//  SWAN
//
//  Created by baidu on 2018/3/9.
//  Copyright © 2018年 baidu. All rights reserved.
//

#import "BBASMUtilities.h"

/**
 *  小程序直播调起接口
 */
@interface BBASMLivePlugin : BBASDPluginBase

/**
 * 描  述: 创建小程序直播组件设置初始参数
 * 示  例: baiduboxapp://swanAPI/live/open?params={"liveId":"myLive","slaveId":"xxx", "src":"xxx","position":{"left":0,"top":0,"width":375,"height":200},"autoplay":true,"muted":false,"orientation":"vertical","objectFit":"contain","backgroundMute":false,"minCache":1,"maxCache":3}&callback=_bdbox_js_57&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_live_open
 * 备  注:
 * ********** description ************
 * @name:      live.insert
 * @authority: swanAPI
 * @path:      /live/open
 * @args:      [{"name": "gesture", "value": "string="}, {"name": "parentId", "value": "string="}, {"name": "hide", "value": "boolean="}, {"name": "slaveId", "value": "string="}, {"name": "liveId", "value": "string="},{"name": "componentId","value": "string="}, {"name": "viewId", "value": "string="}, {"name": "parentId", "value": "string="}, {"name": "src", "value": "string"}, {"name": "position", "value": "Object="}, {"name": "autoplay", "value": "boolean="}, {"name": "muted", "value": "boolean="}, {"name": "orientation", "value": "string="}, {"name": "objectFit", "value": "string="}, {"name": "backgroundMute", "value": "boolean="}, {"name": "minCache", "value": "string="}, {"name": "maxCache", "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)open:(BBASchemeDispatcher *)aCommand;

/**
 * 描  述: 更新直播组件参数
 * 示  例: baiduboxapp://swanAPI/live/update?params={"liveId":"myLive","slaveId":"xxx","src":"http://livebd.quanmin.tv/live/1931315320.m3u8","position":{"left":0,"top":0,"width":375,"height":188},"autoplay":true,"muted":false,"orientation":"vertical","objectFit":"contain","backgroundMute":false,"minCache":1,"maxCache":3}&callback=_bdbox_js_429&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_live_update
 * 备  注:
 * ********** description ************
 * @name:      live.update
 * @authority: swanAPI
 * @path:      /live/update
 * @args:      [{"name": "gesture", "value": "string="},{"name": "parentId", "value": "string="}, {"name": "hide", "value": "boolean="}, {"name": "slaveId", "value": "string="}, {"name": "liveId", "value": "string="},{"name":"componentId","value":  "string="},{"name": "viewId", "value": "string="}, {"name": "parentId", "value": "string="}, {"name": "src", "value": "string="}, {"name": "position", "value": "Object="}, {"name": "autoplay", "value": "boolean="}, {"name": "muted", "value": "boolean="}, {"name": "orientation", "value": "string="}, {"name": "objectFit", "value": "string="}, {"name": "backgroundMute", "value": "boolean="}, {"name": "minCache", "value": "string="}, {"name": "maxCache", "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)update:(BBASchemeDispatcher *)aCommand;

/**
 * 描  述: 直播组件播放
 * 示  例: baiduboxapp://swanAPI/live/play?params={"liveId":"myLive"}&callback=_bdbox_js_773&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_live_play
 * 备  注:
 * ********** description ************
 * @name:      live.play
 * @authority: swanAPI
 * @path:      /live/play
 * @args:      [{"name": "slaveId", "value": "string"}, {"name": "liveId", "value": "string="},{"name":"componentId","value":  "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)play:(BBASchemeDispatcher *)aCommand;

/**
 * 描  述: 小程序直播组件暂停
 * 示  例: baiduboxapp://swanAPI/live/stop?params={"liveId":"myLive"}&callback=_bdbox_js_775&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_live_stop
 * 备  注:
 * ********** description ************
 * @name:      live.stop
 * @authority: swanAPI
 * @path:      /live/stop
 * @args:      [{"name": "slaveId", "value": "string"}, {"name": "liveId", "value": "string="},{"name":"componentId","value":  "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)stop:(BBASchemeDispatcher *)aCommand;

/**
 * 描  述: 小程序live-player静音
 * 示  例: baiduboxapp://swanAPI/live/mute?params={"liveId":"myLive","slaveId":"xxx","src":"http://livebd.quanmin.tv/live/1931315320.m3u8","position":{"left":0,"top":0,"width":375,"height":188},"autoplay":true,"muted":false,"orientation":"vertical","objectFit":"contain","backgroundMute":false,"minCache":1,"maxCache":3}&callback=_bdbox_js_429&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_live_mute
 * 备  注:
 * ********** description ************
 * @name:      live.mute
 * @authority: swanAPI
 * @path:      /live/mute
 * @args:      [{"name": "slaveId", "value": "string"}, {"name": "liveId", "value": "string="},{"name":"componentId","value":  "string="},{"name": "muted", "value": "boolean"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)mute:(BBASchemeDispatcher *)aCommand;

/**
 * 描  述: 小程序直播全屏
 * 示  例: baiduboxapp://swanAPI/live/fullScreen?params={"liveId":"myLive","fullScreen":true,"direction":"90"}&callback=_bdbox_js_147&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_live_fullscreen
 * 备  注:
 * ********** description ************
 * @name:      live.fullScreen
 * @authority: swanAPI
 * @path:      /live/fullScreen
 * @args:      [{"name": "slaveId",  "value": "string"},  {"name": "liveId",  "value": "string="},{"name": "componentId","value": "string="},{"name": "fullScreen",  "value": "boolean"},  {"name": "direction",  "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)fullScreen:(BBASchemeDispatcher *)aCommand;

/**
 * 描  述: 移除直播组件
 * 示  例: baiduboxapp://swanAPI/live/remove?params={"liveId":"myLive","slaveId":"6"}&callback=_bdbox_js_429&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_live_remove
 * 备  注:
 * ********** description ************
 * @name:      live.remove
 * @authority: swanAPI
 * @path:      /live/remove
 * @args:      [{"name": "slaveId", "value": "string="}, {"name": "liveId", "value": "string="},{"name": "componentId","value": "string="},{"name": "viewId", "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)remove:(BBASchemeDispatcher *)aCommand;

/**
 * 描  述: 小程序直播组件pause端能力
 * 示  例: baiduboxapp://swanAPI/live/pause?params={"liveId":"myLive"}&callback=_bdbox_js_759&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_pause
 * 备  注:
 * ********** description ************
 * @name:      live.pause
 * @authority: swanAPI
 * @path:      /live/pause
 * @args:      [{"name": "slaveId", "value": "string"}, {"name": "liveId", "value": "string="},{"name": "componentId","value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)pause:(BBASchemeDispatcher *)aCommand;

/**
 * 描  述: 小程序直播组件pause端能力
 * 示  例: baiduboxapp://swanAPI/live/resume?params={"liveId":"myLive"}&callback=_bdbox_js_765&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_resume
 * 备  注:
 * ********** description ************
 * @name:      live.resume
 * @authority: swanAPI
 * @path:      /live/resume
 * @args:      [{"name": "slaveId", "value": "string"}, {"name": "liveId", "value": "string="},{"name": "componentId","value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)resume:(BBASchemeDispatcher *)aCommand;

@end