播放组件—器材创建——接口文档

播放组件—器材创建——接口文档

接口文档

1.创建器材模板——异步

public YieldAsyncOperationWithResult<string> CreateTemplatedEquipmentAsync(
                               string equipCode,
                               CreateEquipConditions condition)

参数:

参数名 类型 说明
equipCode string 器材编码
condition CreateEquipConditions 传给lua的附加信息

附加说明

    /// <summary>
    /// 创建器材附加信息
    /// </summary>
    [Flags]
    public enum CreateEquipConditions
    {
        None = 0,
        /// <summary>
        /// 创建的时候关闭器材引擎相关功能
        /// </summary>
        Disable = 1,
        /// <summary>
        /// 标记是否是器材介绍界面创建的模型
        /// </summary>
        CreateFromIntro = 2
    }

返回值说明

参数名 类型 说明
YieldAsyncOperationWithResult<string> 自定义协程,主要作用有:1.更精确的控制创建的进行状态,2.返回需要的值,这里是创建的模板的guid

是否通过接口测试

2.创建器材模板——同步

public string CreateTemplatedEquipment(string equipCode,
                                       CreateEquipConditions condition)

参数:

参数名 类型 说明
equipCode string 器材编码
condition CreateEquipConditions 传给lua的附加信息

附加说明

    /// <summary>
    /// 创建器材附加信息
    /// </summary>
    [Flags]
    public enum CreateEquipConditions
    {
        None = 0,
        /// <summary>
        /// 创建的时候关闭器材引擎相关功能
        /// </summary>
        Disable = 1,
        /// <summary>
        /// 标记是否是器材介绍界面创建的模型
        /// </summary>
        CreateFromIntro = 2
    }

返回值说明

参数名 类型 说明
string 创建的模板的guid

是否通过接口测试

3.创建实体器材——异步

public YieldAsyncOperationWithResult<string> CreateEquipmentAsync(
                                    string guid, 
                                    EquipObjectType equipObjectType,
                                    CreateEquipConditions condition)

参数:

参数名 类型 说明
guid string 器材编码
equipObjectType EquipObjectType 创建类型
condition CreateEquipConditions 传给lua的附加信息

附加说明

    /// <summary>
    /// 创建器材附加信息
    /// </summary>
    [Flags]
    public enum CreateEquipConditions
    {
        None = 0,
        /// <summary>
        /// 创建的时候关闭器材引擎相关功能
        /// </summary>
        Disable = 1,
        /// <summary>
        /// 标记是否是器材介绍界面创建的模型
        /// </summary>
        CreateFromIntro = 2
    }

        /// <summary>
    /// 场景中器件的创建类型
    /// </summary>
    public enum EquipObjectType
    {
        /// <summary>
        /// 场景
        /// </summary>
        Scene = 0,

        /// <summary>
        /// 器材列表
        /// </summary>
        EquipTemplate = 1,

        /// <summary>
        /// 器材库
        /// </summary>
        EquipLibrary = 2,

        /// <summary>
        /// 动态创建的
        /// </summary>
        EquipDynamic = 3
    }

返回值说明

参数名 类型 说明
YieldAsyncOperationWithResult<string> 自定义协程,主要作用有:1.更精确的控制创建的进行状态,2.返回需要的值,这里是创建的器材的guid

是否通过接口测试

4.创建实体器材——同步

public string CreateEquipment(string guid, 
                              EquipObjectType equipObjectType,
                              CreateEquipConditions condition)

参数:

参数名 类型 说明
guid string 器材编码
equipObjectType EquipObjectType 创建类型
condition CreateEquipConditions 传给lua的附加信息

附加说明

    /// <summary>
    /// 创建器材附加信息
    /// </summary>
    [Flags]
    public enum CreateEquipConditions
    {
        None = 0,
        /// <summary>
        /// 创建的时候关闭器材引擎相关功能
        /// </summary>
        Disable = 1,
        /// <summary>
        /// 标记是否是器材介绍界面创建的模型
        /// </summary>
        CreateFromIntro = 2
    }

        /// <summary>
    /// 场景中器件的创建类型
    /// </summary>
    public enum EquipObjectType
    {
        /// <summary>
        /// 场景
        /// </summary>
        Scene = 0,

        /// <summary>
        /// 器材列表
        /// </summary>
        EquipTemplate = 1,

        /// <summary>
        /// 器材库
        /// </summary>
        EquipLibrary = 2,

        /// <summary>
        /// 动态创建的
        /// </summary>
        EquipDynamic = 3
    }

返回值说明

参数名 类型 说明
string 器材数据的guid

是否通过接口测试

5.删除模板数据(只是数据,不包括UI表现)

public void DeleteEquipTemplate(string guid)

参数:

参数名 类型 说明
guid string 模板数据编码

是否通过接口测试

6.添加器材模板(只是数据,不包括UI表现)

public bool AddEquipTemplate(CourseEquipTemplate equipTemplate)

参数:

参数名 类型 说明
equipTemplate CourseEquipTemplate 模板数据

返回值说明

参数名 类型 说明
bool 是否添加成功

是否通过接口测试

7.删除实体器材数据(只是数据,不包括表现)

public void DeleteEquipObject(string guid)

参数:

参数名 类型 说明
guid string 实体器材编码

是否通过接口测试

8.添加实体器材(只是数据,不包括表现)

public void AddEquipObject(EquipObjectData data)

参数:

参数名 类型 说明
data EquipObjectData 器材数据

是否通过接口测试