TVOPreflightReport

Objective-C

@interface TVOPreflightReport : NSObject

Swift

class TVOPreflightReport : NSObject

TVOPreflightReport contains the detailed report of the preflight test. This object is returned in the [TVOPreflightDelegate preflight:didCompleteWithReport:] callback when the preflight test is successfully completed.

  • @brief The call SID for the preflight test call.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSString *callSid;

    Swift

    var callSid: String { get }

  • @brief The edge used during the preflight test.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSString *edge;

    Swift

    var edge: String { get }

  • @brief The edge set by the application.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSString *selectedEdge;

    Swift

    var selectedEdge: String { get }

  • @brief An array of gathered ICE candidates during the preflight test.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<TVOPreflightIceCandidate *> *iceCandidates;

    Swift

    var iceCandidates: [TVOPreflightIceCandidate] { get }

  • @brief Network timings for the signaling connection, ice connection, peer connection and preflight tes

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) TVOPreflightNetworkTiming *networkTimings;

    Swift

    var networkTimings: TVOPreflightNetworkTiming { get }

  • @brief An array of stats samples obtained from webRTC periodically during the preflight test.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<TVOPreflightStatsSample *> *samples;

    Swift

    var samples: [TVOPreflightStatsSample] { get }

  • @brief Network stats such as jitter, mos, and rtt.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) TVOPreflightNetworkStats *networkStats;

    Swift

    var networkStats: TVOPreflightNetworkStats { get }

  • @brief Returns true in NSNumber if TURN server was used during the preflight test, otherwisefalse. Returns nil if no ICE candidates were selected.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSNumber *isTurnRequired;

    Swift

    var isTurnRequired: NSNumber? { get }

  • @brief The TVOPreflightCallQuality value in NSNumber based on the average mos obtained during the preflight test. Nil indicates that call quality metric is not available for the preflight test.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSNumber *callQuality;

    Swift

    var callQuality: NSNumber? { get }

  • @brief An array of call quality or audio level warnings received during the preflight test.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<TVOPreflightWarning *> *warnings;

    Swift

    var warnings: [TVOPreflightWarning] { get }

  • @brief An array of call quality or audio level warnings cleared during the preflight test.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<TVOPreflightWarningCleared *> *warningsCleared;

    Swift

    var warningsCleared: [TVOPreflightWarningCleared] { get }

  • @brief The selected local and remote ice candidate used by the preflight test.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) TVOPreflightSelectedIceCandidatePair *selectedIceCandidatePair;

    Swift

    var selectedIceCandidatePair: TVOPreflightSelectedIceCandidatePair { get }

  • @brief Returns a dictionary representation of the detailed report of the preflight test.

    Declaration

    Objective-C

    - (nonnull NSDictionary *)dictionaryReport;

    Swift

    func dictionaryReport() -> [AnyHashable : Any]

  • Unavailable

    Developers shouldn’t initialize this class directly.

    @brief Developers shouldn’t initialize this class directly.

    Declaration

    Objective-C

    - (null_unspecified instancetype)init;