PCast™ SDK

@import PhenixSdk;
 
id<PhenixPCast> pcast = [PhenixPCastFactory createPCast];
 
// #1 Default initialization options
[pcast initialize];
 
// OR
 
// #2 Custom initialization options
PhenixPCastInitializeOptions* initOptions = [PhenixPCastInitializeOptions new];
initOptions.enableProcessTerminationSignalHandling = NO;
 
[pcast initialize:initOptions];

@import PhenixSdk;
 
id<PhenixPCastInitializeOptions> initOptions = [PhenixPCastInitializeOptions new];
initOptions.streamingSourceMapping = [PhenixStreamingSourceMapping new];
 
initOptions.streamingSourceMapping.patternToReplace = @"https:\\/\\/phenixrts\\.com\\/video";
initOptions.streamingSourceMapping.replacement = @"https://myown.cdn.com";

@import PhenixSdk;
 
// Generated via EdgeAuth library
NSString* authenticationToken = ...;
// Previously initialized
id<PhenixPCast> pcast = ...;
 
[pcast start:
    authenticationToken:
    ^(id<PhenixPCast> pcast, PhenixRequestStatus status, NSString* sessionId) {
        if (status == PhenixRequestStatusOk) {
            NSLog(@"PCast started...");
        } else {
            NSLog(@"Failed to start PCast...");
        }
    }:
    ^(id<PhenixPCast> pcast) {
        NSLog(@"We are online...");
    }:
    ^(id<PhenixPCast> pcast) {
        NSLog(@"We are offline...");
    }];

@import PhenixSdk;
 
// Previously initialized and started
id<PhenixPCast> pcast = ...;
 
[pcast stop];
 
// Once you are done using PCast (e.g. exiting the app)
[pcast shutdown];

@import PhenixSdk;
 
// Previously initialized and started
id<PhenixPCast> pcast = ...;
 
PhenixUserMediaOptions* gumOptions = [PhenixUserMediaOptions new]
 
// Customize options if desired
gumOptions.video.capabilityConstraints
    [[NSNumber numberWithInteger:PhenixDeviceCapabilityFacingMode]] =
    @[ [PhenixDeviceConstraint initWithFacingMode:PhenixFacingModeUser] ];
gumOptions.video.capabilityConstraints
    [[NSNumber numberWithInteger: PhenixDeviceCapabilityFlashMode]] =
    @[ [PhenixDeviceConstraint initWithFlashMode:PhenixFlashModeAlwaysOff] ];
gumOptions.video.capabilityConstraints
    [[NSNumber numberWithInteger: PhenixDeviceCapabilityHeight]] =
    @[ [PhenixDeviceConstraint initWithDouble:720:PhenixConstraintTypeExact] ];
gumOptions.video.capabilityConstraints
    [[NSNumber numberWithInteger: PhenixDeviceCapabilityWidth]] =
    @[ [PhenixDeviceConstraint initWithDouble:800:PhenixConstraintTypeMin],
       [PhenixDeviceConstraint initWithDouble:1500:PhenixConstraintTypeMax] ];
gumOptions.audio.enabled = NO;
 
[pcast getUserMedia:
    gumOptions:
    ^(id<PhenixPCast> pcast,
      PhenixRequestStatus status,
      id<PhenixUserMediaStream> userMediaStream) {
        // Check status and store 'userMediaStream'
    }];

@import PhenixSdk;
 
// Previously obtained via 'getUserMedia'
id<PhenixUserMediaStream> userMediaStream = ...;
 
// Previously initialized and used with 'getUserMedia'
PhenixUserMediaOptions* gumOptions;
 
[gumOptions.video.capabilityConstraints
    [[NSNumber numberWithInteger:PhenixDeviceCapabilityFacingMode]][0]
        updateFacingMode:PhenixFacingModeEnvironment];
gumOptions.video.capabilityConstraints
    [[NSNumber numberWithInteger:PhenixDeviceCapabilityFlashMode]][0]
        updateFlashMode: PhenixFlashModeAlwaysOn];
 
[userMediaStream applyOptions:gumOptions];

@import PhenixSdk;
 
// Previously initialized and started
id<PhenixPCast> pcast = ...;
 
[pcast enumerateSourceDevices:^(id<PhenixPCast> pcast, NSArray<PhenixSourceDeviceInfo*>* devices) {
    // Store devices as needed
}:PhenixMediaTypeVideo];

@import PhenixSdk;
 
// Previously initialized and started
id<PhenixPCast> pcast = ...;
// Previously generated via EdgeAuth library
NSString* streamToken = ...;
// Previously obtained via either PCast.subscribe or PhenixUserMediaStream.mediaStream
id<PhenixMediaStream> mediaStream = ...;
 
NSArray* tags = @[ @"my-tag" ];
 
[pcast publish:
    streamToken:
    mediaStream:
    ^(id<PhenixPCast> pcast, PhenixRequestStatus status, id<PhenixPublisher> publisher) {
        // Check status and store 'publisher'
 
        // The "streamId" of the publisher
        NSString* streamId = publisher.streamId;
 
        if (publisher.hasEnded == YES) {
            // Checks if the publisher has ended
        }
 
        // Attach publisher ended callback
        [publisher setPublisherEndedCallback:
            ^(id<PhenixPublisher> publisher,
              PhenixStreamEndedReason reason,
              NSString* reasonDescription) {
                // Called when the stream has ended
                NSLog(@"Publish stream ended with reason [%@]", reasonDescription);
            }];
 
        // To stop later
        [publisher stop:@"I-am-done-publishing"];
    }:
    tags];

@import PhenixSdk;
 
// Previously initialized and started
id<PhenixPCast> pcast = ...;
// Previously generated via EdgeAuth library
NSString* streamToken = ...;
 
[pcast subscribe:
    streamToken:
    ^(id<PhenixPCast> pcast,
      PhenixRequestStatus status,
      id<PhenixMediaStream> mediaStream) {
        // Check status and store 'mediaStream'
 
        // Attach stream ended callback
        [mediaStream setStreamEndedCallback:
            ^(id<PhenixMediaStream> mediaStream,
              PhenixStreamEndedReason reason,
              NSString* reasonDescription) {
                NSLog(@"Subscriber stream ended with reason [%@]", reasonDescription);
        }];
 
        // To stop later
        [mediaStream stop];
    }];

@import PhenixSdk;
 
// Previously obtained via either PCast.subscribe or PhenixUserMediaStream.mediaStream
id<PhenixMediaStream> mediaStream = ...;
 
id<PhenixRenderer> renderer = [mediaStream createRenderer];
 
[renderer setRenderSurfaceReadyCallback:
    ^(id<PhenixRenderer> renderer, CALayer* renderSurface) {
        // Attach layer to UI and set fill options and/or resize as needed
        // NOTE: This may be called more than once (e.g. after interruptions)
    }];
 
PhenixRendererStartStatus status = [renderer start];
 
// To stop later
[renderer stop];

@import PhenixSdk;
 
// Previously obtained via either PCast.subscribe or PhenixUserMediaStream.mediaStream
id<PhenixMediaStream> mediaStream = ...;
 
PhenixRendererOptions* options = [PhenixRendererOptions new];
options.aspectRatioMode = PhenixAspectRatioModeFill;
options.useNullVideoDevice = false;
options.useNullAudioDevice = true;
 
 
id<PhenixRenderer> renderer = [mediaStream createRenderer:options];

@import PhenixSdk;
 
// Previously obtained via 'getUserMedia'
id<PhenixUserMediaStream> userMediaStream = ...;
 
id<PhenixRenderer> renderer = [userMediaStream.mediaStream createRenderer];

@import PhenixSdk;
 
// Previously obtained from media stream
id<PhenixRenderer> renderer = ...;
 
BOOL isMuted = renderer.audioMuted;
[renderer muteAudio];
[renderer unmuteAudio];

@import PhenixSdk;
 
// Previously obtained from media stream and started
id<PhenixRenderer> renderer = ...;
 
[renderer setLastVideoFrameRenderedReceivedCallback:
    ^(id<PhenixRenderer> pcast, CVPixelBufferRef nativeVideoFrame) {
        // NOTE: If frame is dispatched to another thread, ensure its reference
        //       is kept alive by using CVPixelBufferRetain/CVPixelBufferRelease
    }];
[renderer requestLastVideoFrameRendered];

@import PhenixSdk;
 
// Previously obtained from media stream and started
id<PhenixRenderer> renderer = ...;
 
[renderer setDataQualityChangedCallback:
    ^(id<PhenixRenderer> renderer,
      PhenixDataQualityStatus status,
      PhenixDataQualityReason reason) {
        // Inform user, take action based on status and reason
    }];
 
// Previously obtained via PCast.publish
id<PhenixPublisher> publisher = ...;
 
[publisher setDataQualityChangedCallback:
    ^(id<PhenixPublisher> publisher,
      PhenixDataQualityStatus status,
      PhenixDataQualityReason reason) {
        // Inform user, take action based on status and reason
    }];

@import PhenixSdk;
 
// Previously obtained from media stream
id<PhenixRenderer> renderer = ...;
 
[renderer setVideoDisplayDimensionsChangedCallback:
    ^(id<PhenixRenderer> renderer, const struct PhenixDimensions* displayDimensions) {
        // displayDimensions->width, displayDimensions->height
        // Can get called multiple times while rendering a stream
    }];