PLVWLogReporterManager

Objective-C

@interface PLVWLogReporterManager : NSObject

+ (instancetype)sharedManager;

/**
 云课堂直播间登录时调用
 */
- (void)registerReporterWithChannelId:(NSString *)channelId
                                appId:(NSString *)appId
                            appSecret:(NSString *)appSecret
                               userId:(NSString *)userId DEPRECATED_MSG_ATTRIBUTE("已废弃，请使用registerReporterWithChannelId:userId:");

/**
 云课堂直播间登录时调用
 @note elog track 日志需要相关信息
 */
- (void)registerReporterWithChannelId:(NSString *)channelId
                               userId:(NSString *)userId;

/**
 云课堂回放登录时调用
 */
- (void)registerReporterWithChannelId:(NSString *)channelId
                                appId:(NSString *)appId
                            appSecret:(NSString *)appSecret
                               userId:(NSString *)userId
                                  vId:(NSString *)vId DEPRECATED_MSG_ATTRIBUTE("已废弃，请使用registerReporterWithChannelId:userId:vId:");

/**
 云课堂回放登录时调用
 @note elog track 日志需要相关信息
 */
- (void)registerReporterWithChannelId:(NSString *)channelId
                               userId:(NSString *)userId
                                  vId:(NSString *)vId;

/**
 手机开播、互动学堂登录时调用
 @note 仅在productType为PLVProductTypeStreamer或PLVProductTypeHiClass时生效
 @note elog 日志需要相关信息
 */
- (void)registerReporterWithChannelId:(NSString *)channelId productType:(PLVFLogProductType)productType;

/**
 云课堂直播/回放退出登录时调用
 */
- (void)clear;


#pragma mark - ELog

/**
Elog 上报器错误日志上报接口 1
*/
- (void)reportWithErrorCode:(NSInteger)errorCode
                information:(id __nullable)information;

/**
 Elog 事件上报便利接口 1
 */
- (void)reportWithEvent:(NSString *)event
                  modul:(NSString *)modul
        informationType:(NSString * __nullable)type
        informationData:(id __nullable)data;

/**
Elog 事件上报便利接口 2
*/
- (void)reportWithEvent:(NSString *)event
                  modul:(NSString *)modul
            information:(id __nullable)information;

/**
Elog 事件上报便利接口 1 - 批量上报
*/
- (void)reportWithEvent:(NSString *)event
                  modul:(NSString *)modul
        informationType:(NSString * __nullable)type
        informationData:(id __nullable)data
                  patch:(BOOL)patch;

/**
Elog 事件上报便利接口 2 - 批量上报
*/
- (void)reportWithEvent:(NSString *)event
                  modul:(NSString *)modul
            information:(id __nullable)information
                  patch:(BOOL)patch;

#pragma mark - View Log

/**
直播播放信息统计：用于直播、回放时
@param param 统计后台用户自定义参数配置类
@param playerId 播放器ID
*/
- (void)reportLiveViewLogWithParam:(PLVViewLogCustomParam *)param
                          playerId:(NSString *)playerId
               logModelConfigBlock:(PLVFViewLogModel *(^)(void))configBlock;

/**
点播播放信息统计：用于播放点播视频时
 @param param 统计后台用户自定义参数配置类
 @param playerId 播放器ID
*/
- (void)reportVodViewLogWithParam:(PLVViewLogCustomParam *)param
                         playerId:(NSString *)playerId
              logModelConfigBlock:(PLVFViewLogModel *(^)(void))configBlock;

#pragma mark - Qos

/**
服务质量统计
*/
/**
直播首次加载时长
@param channel 频道信息
@param time 首次加载时长
@param time_player 首次加载播放器起播时长
@param time_business 首次加载播放器业务流程时长
@param playerId 播放器ID
*/
- (void)reportLiveLoadingQosWithChannel:(PLVChannelInfoModel *)channel
                                   time:(int)time
                            time_player:(int)time_player
                          time_business:(int)time_business
                               playerId:(NSString *)playerId;

/**
回放首次加载时长
@param channel 频道信息
@param time 首次加载时长
@param time_player 首次加载播放器起播时长
@param time_business 首次加载播放器业务流程时长
@param playerId 播放器ID
@param vid 视频vid
*/
- (void)reportVodLoadingQosWithChannel:(PLVChannelInfoModel *)channel
                                  time:(int)time
                           time_player:(int)time_player
                         time_business:(int)time_business
                              playerId:(NSString *)playerId
                                   vid:(NSString *)vid;

/**
 直播二次缓冲时长
 @param channel 频道信息
 @param time 二次缓冲时长
 @param playerId 播放器ID
 */
- (void)reportLiveBufferQosWithChannel:(PLVChannelInfoModel *)channel
                                  time:(int)time
                              playerId:(NSString *)playerId;

/**
 回放二次缓冲时长
 @param channel 频道信息
 @param time 二次缓冲时长
 @param playerId 播放器ID
 @param vid 视频vid
 */
- (void)reportVodBufferQosWithChannel:(PLVChannelInfoModel *)channel
                                 time:(int)time
                             playerId:(NSString *)playerId
                                  vid:(NSString *)vid;

/**
 直播卡顿
 @param channel 频道信息
 @param time 卡顿时长
 @param playerId 播放器ID
 */
- (void)reportLiveStallingQosWithChannel:(PLVChannelInfoModel *)channel
                                  time:(int)time
                              playerId:(NSString *)playerId;

/**
 直播播放出错
@param channel 频道信息
@param uri 请求资源的URI
@param status 服务器响应的状态码
@param errorcode 错误代码
@param errormsg 错误内容描述
@param playerId 播放器ID
*/
- (void)reportLiveErrorQosWithChannel:(PLVChannelInfoModel *)channel
                                  uri:(NSString *)uri
                               status:(NSString *)status
                            errorcode:(NSString *)errorcode
                             errormsg:(NSString *)errormsg
                             playerId:(NSString *)playerId;

/**
 回放播放出错
@param channel 频道信息
@param uri 请求资源的URI
@param status 服务器响应的状态码
@param errorcode 错误代码
@param errormsg 错误内容描述
@param playerId 播放器ID
@param vid 视频vid
*/
- (void)reportVodErrorQosWithChannel:(PLVChannelInfoModel *)channel
                                 uri:(NSString *)uri
                              status:(NSString *)status
                           errorcode:(NSString *)errorcode
                            errormsg:(NSString *)errormsg
                            playerId:(NSString *)playerId
                                 vid:(NSString *)vid;

#pragma mark - track Log

/// 开启/关闭 track 日志打点
- (void)enableTrackEventReport:(BOOL)enable;

/// track 体系日志配置viewerId、viewerName、用户角色
- (void)setupViewerId:(NSString *)viewerId viewerName:(NSString *)viewerName role:(NSString *)role;

/// track 体系日志配置场次ID
- (void)setupSessionId:(NSString *)sessionId;

/// track 体系日志上报
/// - Parameters:
///   - eventId: 事件id，用于区分不同事件
///   - eventType: 事件类型，如click、show
///   - specInformation: 事件专有属性
- (void)reportTrackWithEventId:(NSString *)eventId
                     eventType:(NSString *)eventType
               specInformation:(NSDictionary *)specInformation;

/// track 体系日志上报
/// - Parameters:
///   - eventId: 事件id，用于区分不同事件
///   - eventType: 事件类型，如click、show
///   - specInformation: 事件专有属性数组
- (void)reportTrackWithEventId:(NSString *)eventId
                     eventType:(NSString *)eventType
          specInformationArray:(NSArray *)specInformationArray;

@end

Swift

class PLVWLogReporterManager : NSObject

Undocumented

  • Undocumented

    Declaration

    Objective-C

    + (instancetype)sharedManager;

    Swift

    class func shared() -> Self

  • Deprecated

    已废弃，请使用registerReporterWithChannelId:userId:

    云课堂直播间登录时调用

    Declaration

    Objective-C

    - (void)registerReporterWithChannelId:(nonnull NSString *)channelId
                                appId:(nonnull NSString *)appId
                            appSecret:(nonnull NSString *)appSecret
                               userId:(nonnull NSString *)userId;

    Swift

    func registerReporter(withChannelId channelId: String, appId: String, appSecret: String, userId: String)

  • 云课堂直播间登录时调用

    Note

    elog track 日志需要相关信息

    Declaration

    Objective-C

    - (void)registerReporterWithChannelId:(nonnull NSString *)channelId
                               userId:(nonnull NSString *)userId;

    Swift

    func registerReporter(withChannelId channelId: String, userId: String)

  • Deprecated

    已废弃，请使用registerReporterWithChannelId:userId:vId:

    云课堂回放登录时调用

    Declaration

    Objective-C

    - (void)registerReporterWithChannelId:(nonnull NSString *)channelId
                                appId:(nonnull NSString *)appId
                            appSecret:(nonnull NSString *)appSecret
                               userId:(nonnull NSString *)userId
                                  vId:(nonnull NSString *)vId;

    Swift

    func registerReporter(withChannelId channelId: String, appId: String, appSecret: String, userId: String, vId: String)

  • 云课堂回放登录时调用

    Note

    elog track 日志需要相关信息

    Declaration

    Objective-C

    - (void)registerReporterWithChannelId:(nonnull NSString *)channelId
                               userId:(nonnull NSString *)userId
                                  vId:(nonnull NSString *)vId;

    Swift

    func registerReporter(withChannelId channelId: String, userId: String, vId: String)

  • 手机开播、互动学堂登录时调用

    Note

    仅在productType为PLVProductTypeStreamer或PLVProductTypeHiClass时生效

    Note

    elog 日志需要相关信息

    Declaration

    Objective-C

    - (void)registerReporterWithChannelId:(nonnull NSString *)channelId
                          productType:(id)productType;

    Swift

    func registerReporter(withChannelId channelId: String, productType: Any!)

  • 云课堂直播/回放退出登录时调用

    Declaration

    Objective-C

    - (void)clear;

    Swift

    func clear()

ELog

  • Elog 上报器错误日志上报接口 1

    Declaration

    Objective-C

    - (void)reportWithErrorCode:(NSInteger)errorCode
                information:(id _Nullable)information;

    Swift

    func reportWithErrorCode(_ errorCode: Int, information: Any?)

  • Elog 事件上报便利接口 1

    Declaration

    Objective-C

    - (void)reportWithEvent:(nonnull NSString *)event
                  modul:(nonnull NSString *)modul
        informationType:(NSString *_Nullable)type
        informationData:(id _Nullable)data;

    Swift

    func report(withEvent event: String, modul: String, informationType type: String?, informationData data: Any?)

  • Elog 事件上报便利接口 2

    Declaration

    Objective-C

    - (void)reportWithEvent:(nonnull NSString *)event
                  modul:(nonnull NSString *)modul
            information:(id _Nullable)information;

    Swift

    func report(withEvent event: String, modul: String, information: Any?)

  • Elog 事件上报便利接口 1 - 批量上报

    Declaration

    Objective-C

    - (void)reportWithEvent:(nonnull NSString *)event
                  modul:(nonnull NSString *)modul
        informationType:(NSString *_Nullable)type
        informationData:(id _Nullable)data
                  patch:(BOOL)patch;

    Swift

    func report(withEvent event: String, modul: String, informationType type: String?, informationData data: Any?, patch: Bool)

  • Elog 事件上报便利接口 2 - 批量上报

    Declaration

    Objective-C

    - (void)reportWithEvent:(nonnull NSString *)event
                  modul:(nonnull NSString *)modul
            information:(id _Nullable)information
                  patch:(BOOL)patch;

    Swift

    func report(withEvent event: String, modul: String, information: Any?, patch: Bool)

View Log

  • 直播播放信息统计：用于直播、回放时

    Declaration

    Objective-C

    - (void)reportLiveViewLogWithParam:(nonnull PLVViewLogCustomParam *)param
                          playerId:(nonnull NSString *)playerId
               logModelConfigBlock:
                   (nonnull PLVFViewLogModel *_Nonnull (^)(void))configBlock;

    Swift

    func reportLiveViewLog(with param: PLVViewLogCustomParam, playerId: String, logModelConfigBlock configBlock: @escaping () -> PLVFViewLogModel)

    Parameters

    param

    统计后台用户自定义参数配置类
    playerId

    播放器ID

  • 点播播放信息统计：用于播放点播视频时

    Declaration

    Objective-C

    - (void)reportVodViewLogWithParam:(nonnull PLVViewLogCustomParam *)param
                         playerId:(nonnull NSString *)playerId
              logModelConfigBlock:
                  (nonnull PLVFViewLogModel *_Nonnull (^)(void))configBlock;

    Swift

    func reportVodViewLog(with param: PLVViewLogCustomParam, playerId: String, logModelConfigBlock configBlock: @escaping () -> PLVFViewLogModel)

    Parameters

    param

    统计后台用户自定义参数配置类
    playerId

    播放器ID

Qos

  • 服务质量统计

    直播首次加载时长

    Declaration

    Objective-C

    - (void)reportLiveLoadingQosWithChannel:(nonnull PLVChannelInfoModel *)channel
                                   time:(int)time
                            time_player:(int)time_player
                          time_business:(int)time_business
                               playerId:(nonnull NSString *)playerId;

    Swift

    func reportLiveLoadingQos(withChannel channel: PLVChannelInfoModel, time: Int32, time_player: Int32, time_business: Int32, playerId: String)

    Parameters

    channel

    频道信息
    time

    首次加载时长
    time_player

    首次加载播放器起播时长
    time_business

    首次加载播放器业务流程时长
    playerId

    播放器ID

  • 回放首次加载时长

    Declaration

    Objective-C

    - (void)reportVodLoadingQosWithChannel:(nonnull PLVChannelInfoModel *)channel
                                  time:(int)time
                           time_player:(int)time_player
                         time_business:(int)time_business
                              playerId:(nonnull NSString *)playerId
                                   vid:(nonnull NSString *)vid;

    Swift

    func reportVodLoadingQos(withChannel channel: PLVChannelInfoModel, time: Int32, time_player: Int32, time_business: Int32, playerId: String, vid: String)

    Parameters

    channel

    频道信息
    time

    首次加载时长
    time_player

    首次加载播放器起播时长
    time_business

    首次加载播放器业务流程时长
    playerId

    播放器ID
    vid

    视频vid

  • 直播二次缓冲时长

    Declaration

    Objective-C

    - (void)reportLiveBufferQosWithChannel:(nonnull PLVChannelInfoModel *)channel
                                  time:(int)time
                              playerId:(nonnull NSString *)playerId;

    Swift

    func reportLiveBufferQos(withChannel channel: PLVChannelInfoModel, time: Int32, playerId: String)

    Parameters

    channel

    频道信息
    time

    二次缓冲时长
    playerId

    播放器ID

  • 回放二次缓冲时长

    Declaration

    Objective-C

    - (void)reportVodBufferQosWithChannel:(nonnull PLVChannelInfoModel *)channel
                                 time:(int)time
                             playerId:(nonnull NSString *)playerId
                                  vid:(nonnull NSString *)vid;

    Swift

    func reportVodBufferQos(withChannel channel: PLVChannelInfoModel, time: Int32, playerId: String, vid: String)

    Parameters

    channel

    频道信息
    time

    二次缓冲时长
    playerId

    播放器ID
    vid

    视频vid

  • 直播卡顿

    Declaration

    Objective-C

    - (void)reportLiveStallingQosWithChannel:(nonnull PLVChannelInfoModel *)channel
                                    time:(int)time
                                playerId:(nonnull NSString *)playerId;

    Swift

    func reportLiveStallingQos(withChannel channel: PLVChannelInfoModel, time: Int32, playerId: String)

    Parameters

    channel

    频道信息
    time

    卡顿时长
    playerId

    播放器ID

  • 直播播放出错

    Declaration

    Objective-C

    - (void)reportLiveErrorQosWithChannel:(nonnull PLVChannelInfoModel *)channel
                                  uri:(nonnull NSString *)uri
                               status:(nonnull NSString *)status
                            errorcode:(nonnull NSString *)errorcode
                             errormsg:(nonnull NSString *)errormsg
                             playerId:(nonnull NSString *)playerId;

    Swift

    func reportLiveErrorQos(withChannel channel: PLVChannelInfoModel, uri: String, status: String, errorcode: String, errormsg: String, playerId: String)

    Parameters

    channel

    频道信息
    uri

    请求资源的URI
    status

    服务器响应的状态码
    errorcode

    错误代码
    errormsg

    错误内容描述
    playerId

    播放器ID

  • 回放播放出错

    Declaration

    Objective-C

    - (void)reportVodErrorQosWithChannel:(nonnull PLVChannelInfoModel *)channel
                                 uri:(nonnull NSString *)uri
                              status:(nonnull NSString *)status
                           errorcode:(nonnull NSString *)errorcode
                            errormsg:(nonnull NSString *)errormsg
                            playerId:(nonnull NSString *)playerId
                                 vid:(nonnull NSString *)vid;

    Swift

    func reportVodErrorQos(withChannel channel: PLVChannelInfoModel, uri: String, status: String, errorcode: String, errormsg: String, playerId: String, vid: String)

    Parameters

    channel

    频道信息
    uri

    请求资源的URI
    status

    服务器响应的状态码
    errorcode

    错误代码
    errormsg

    错误内容描述
    playerId

    播放器ID
    vid

    视频vid

track Log

  • 开启/关闭 track 日志打点

    Declaration

    Objective-C

    - (void)enableTrackEventReport:(BOOL)enable;

    Swift

    func enableTrackEventReport(_ enable: Bool)

  • track 体系日志配置viewerId、viewerName、用户角色

    Declaration

    Objective-C

    - (void)setupViewerId:(nonnull NSString *)viewerId
           viewerName:(nonnull NSString *)viewerName
                 role:(nonnull NSString *)role;

    Swift

    func setupViewerId(_ viewerId: String, viewerName: String, role: String)

  • track 体系日志配置场次ID

    Declaration

    Objective-C

    - (void)setupSessionId:(nonnull NSString *)sessionId;

    Swift

    func setupSessionId(_ sessionId: String)

  • track 体系日志上报

    Declaration

    Objective-C

    - (void)reportTrackWithEventId:(nonnull NSString *)eventId
                     eventType:(nonnull NSString *)eventType
               specInformation:(nonnull NSDictionary *)specInformation;

    Swift

    func reportTrack(withEventId eventId: String, eventType: String, specInformation: [AnyHashable : Any])

  • track 体系日志上报

    Declaration

    Objective-C

    - (void)reportTrackWithEventId:(nonnull NSString *)eventId
                     eventType:(nonnull NSString *)eventType
          specInformationArray:(nonnull NSArray *)specInformationArray;

    Swift

    func reportTrack(withEventId eventId: String, eventType: String, specInformationArray: [Any])