STSStreamingLiveEventConfig

@interface STSStreamingLiveEventConfig : NSObject

A STSStreamingLiveEventConfig object defines the configuration of a live event.

  • The title of the live event.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull title;

    Swift

    var title: String { get }

  • The synopsis of the live event.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
    NSString *synopsis;

    Swift

    var synopsis: String? { get set }

  • The id of the category which the live event belongs to.

    If you want to set category id of the live event, you should create categories first. You can create categories in StraaS CMS . Once you create categories, you can get category lists by STSCMSManager in StraaSPlayerSDK or by calling StraaS Get Categories API from your server and get category ids from the response data.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
    NSNumber *categoryId;

    Swift

    var categoryId: NSNumber? { get set }

  • The array of tags which the live event is tagged with.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
    NSArray<NSString *> *tags;

    Swift

    var tags: [String]? { get set }

  • A boolean value indicates whether the live event should be listed.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL listed;

    Swift

    var listed: Bool { get }

  • A boolean value indicates whether to list the new VoD of the live event or not. Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL vodListed;

    Swift

    var vodListed: Bool { get set }

  • A boolean value indicates Whether the new VoD of the live event is available by users or not. Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL vodAvailable;

    Swift

    var vodAvailable: Bool { get set }

  • The max resolution of the live event. Defaults to STSStreamingResolution720p. This property is deprecated. Use profile instead.

    Note: This property only works if profile is equal to STSStreamingProfileNone.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    STSStreamingResolution maxResolution;

    Swift

    var maxResolution: STSStreamingResolution { get set }

  • The profile of the live event. Defaults to STSStreamingProfileNone.

    Note that STSStreamingProfile1080pAndSource can only be used when your account is enabled highest resolution 1080p authority.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    STSStreamingProfile profile;

    Swift

    var profile: STSStreamingProfile { get set }

  • A boolean value indicates whether to merge all VoDs of the live event together. Defaults to NO.

    Note: * If this property is set to YES, only one VoD will be generated, and no temporary VoD will be shown until the live event ends. * This configuration can’t be changed after the live event is created.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL vodMerge;

    Swift

    var vodMerge: Bool { get set }

  • A boolean value indicates whether to enable live DVR feature for a live event. Default value: NO.

    Note: * This configuration can’t be changed after the live event is created. * This property can be set to YES only when your account is enabled live-DVR authority.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL dvrEnabled;

    Swift

    var dvrEnabled: Bool { get set }

  • Creates a STSStreamingLiveEventConfig with given parameters.

    Declaration

    Objective-C

    + (nonnull instancetype)liveEventConfigWithTitle:(nonnull NSString *)title
                                          listed:(BOOL)listed;

    Swift

    convenience init(title: String, listed: Bool)

    Parameters

    title

    The title of the live event.
    listed

    Indicates whether the live event should be listed.

    Return Value

    A newly STSStreamingLiveEventConfig object.