PCast™ SDK

1@import PhenixSdk;
2
3id<PhenixPCast> pcast = [PhenixPCastFactory createPCast];
4
5// #1 Default initialization options
6[pcast initialize];
7
8// OR
9
10// #2 Custom initialization options
11PhenixPCastInitializeOptions* initOptions = [PhenixPCastInitializeOptions new];
12initOptions.enableProcessTerminationSignalHandling = NO;
13
14[pcast initialize:initOptions];

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

1@import PhenixSdk;
2
3// Generated via EdgeAuth library
4NSString* authenticationToken = ...;
5// Previously initialized
6id<PhenixPCast> pcast = ...;
7
8[pcast start:
9    authenticationToken:
10    ^(id<PhenixPCast> pcast, PhenixRequestStatus status, NSString* sessionId) {
11        if (status == PhenixRequestStatusOk) {
12            NSLog(@"PCast started...");
13        } else {
14            NSLog(@"Failed to start PCast...");
15        }
16    }:
17    ^(id<PhenixPCast> pcast) {
18        NSLog(@"We are online...");
19    }:
20    ^(id<PhenixPCast> pcast) {
21        NSLog(@"We are offline...");
22    }];

1@import PhenixSdk;
2
3// Previously initialized and started
4id<PhenixPCast> pcast = ...;
5
6[pcast stop];
7
8// Once you are done using PCast (e.g. exiting the app)
9[pcast shutdown];

1@import PhenixSdk;
2
3// Previously initialized and started
4id<PhenixPCast> pcast = ...;
5
6PhenixUserMediaOptions* gumOptions = [PhenixUserMediaOptions new]
7
8// Customize options if desired
9gumOptions.video.capabilityConstraints
10    [[NSNumber numberWithInteger:PhenixDeviceCapabilityFacingMode]] =
11    @[ [PhenixDeviceConstraint initWithFacingMode:PhenixFacingModeUser] ];
12gumOptions.video.capabilityConstraints
13    [[NSNumber numberWithInteger: PhenixDeviceCapabilityFlashMode]] =
14    @[ [PhenixDeviceConstraint initWithFlashMode:PhenixFlashModeAlwaysOff] ];
15gumOptions.video.capabilityConstraints
16    [[NSNumber numberWithInteger: PhenixDeviceCapabilityHeight]] =
17    @[ [PhenixDeviceConstraint initWithDouble:720:PhenixConstraintTypeExact] ];
18gumOptions.video.capabilityConstraints
19    [[NSNumber numberWithInteger: PhenixDeviceCapabilityWidth]] =
20    @[ [PhenixDeviceConstraint initWithDouble:800:PhenixConstraintTypeMin],
21       [PhenixDeviceConstraint initWithDouble:1500:PhenixConstraintTypeMax] ];
22gumOptions.audio.enabled = NO;
23
24[pcast getUserMedia:
25    gumOptions:
26    ^(id<PhenixPCast> pcast,
27      PhenixRequestStatus status,
28      id<PhenixUserMediaStream> userMediaStream) {
29        // Check status and store 'userMediaStream'
30    }];

1@import PhenixSdk;
2
3// Previously obtained via 'getUserMedia'
4id<PhenixUserMediaStream> userMediaStream = ...;
5
6// Previously initialized and used with 'getUserMedia'
7PhenixUserMediaOptions* gumOptions;
8
9[gumOptions.video.capabilityConstraints
10    [[NSNumber numberWithInteger:PhenixDeviceCapabilityFacingMode]][0]
11        updateFacingMode:PhenixFacingModeEnvironment];
12gumOptions.video.capabilityConstraints
13    [[NSNumber numberWithInteger:PhenixDeviceCapabilityFlashMode]][0]
14        updateFlashMode: PhenixFlashModeAlwaysOn];
15
16[userMediaStream applyOptions:gumOptions];

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

1@import PhenixSdk;
2
3// Previously initialized and started
4id<PhenixPCast> pcast = ...;
5// Previously generated via EdgeAuth library
6NSString* streamToken = ...;
7// Previously obtained via either PCast.subscribe or PhenixUserMediaStream.mediaStream
8id<PhenixMediaStream> mediaStream = ...;
9
10NSArray* tags = @[ @"my-tag" ];
11
12[pcast publish:
13    streamToken:
14    mediaStream:
15    ^(id<PhenixPCast> pcast, PhenixRequestStatus status, id<PhenixPublisher> publisher) {
16        // Check status and store 'publisher'
17
18        // The "streamId" of the publisher
19        NSString* streamId = publisher.streamId;
20
21        if (publisher.hasEnded == YES) {
22            // Checks if the publisher has ended
23        }
24
25        // Attach publisher ended callback
26        [publisher setPublisherEndedCallback:
27            ^(id<PhenixPublisher> publisher,
28              PhenixStreamEndedReason reason,
29              NSString* reasonDescription) {
30                // Called when the stream has ended
31                NSLog(@"Publish stream ended with reason [%@]", reasonDescription);
32            }];
33
34        // To stop later
35        [publisher stop:@"I-am-done-publishing"];
36    }:
37    tags];

1@import PhenixSdk;
2
3// Previously initialized and started
4id<PhenixPCast> pcast = ...;
5// Previously generated via EdgeAuth library
6NSString* streamToken = ...;
7
8[pcast subscribe:
9    streamToken:
10    ^(id<PhenixPCast> pcast,
11      PhenixRequestStatus status,
12      id<PhenixMediaStream> mediaStream) {
13        // Check status and store 'mediaStream'
14
15        // Attach stream ended callback
16        [mediaStream setStreamEndedCallback:
17            ^(id<PhenixMediaStream> mediaStream,
18              PhenixStreamEndedReason reason,
19              NSString* reasonDescription) {
20                NSLog(@"Subscriber stream ended with reason [%@]", reasonDescription);
21        }];
22
23        // To stop later
24        [mediaStream stop];
25    }];

1@import PhenixSdk;
2
3// Previously obtained via either PCast.subscribe or PhenixUserMediaStream.mediaStream
4id<PhenixMediaStream> mediaStream = ...;
5
6id<PhenixRenderer> renderer = [mediaStream createRenderer];
7
8[renderer setRenderSurfaceReadyCallback:
9    ^(id<PhenixRenderer> renderer, CALayer* renderSurface) {
10        // Attach layer to UI and set fill options and/or resize as needed
11        // NOTE: This may be called more than once (e.g. after interruptions)
12    }];
13
14PhenixRendererStartStatus status = [renderer start];
15
16// To stop later
17[renderer stop];

1@import PhenixSdk;
2
3// Previously obtained via either PCast.subscribe or PhenixUserMediaStream.mediaStream
4id<PhenixMediaStream> mediaStream = ...;
5
6PhenixRendererOptions* options = [PhenixRendererOptions new];
7options.aspectRatioMode = PhenixAspectRatioModeFill;
8options.useNullVideoDevice = NO;
9options.useNullAudioDevice = YES;
10
11
12id<PhenixRenderer> renderer = [mediaStream createRenderer:options];

1@import PhenixSdk;
2
3// Previously obtained via 'getUserMedia'
4id<PhenixUserMediaStream> userMediaStream = ...;
5
6id<PhenixRenderer> renderer = [userMediaStream.mediaStream createRenderer];

1@import PhenixSdk;
2
3// Previously obtained from media stream
4id<PhenixRenderer> renderer = ...;
5
6BOOL isMuted = renderer.audioMuted;
7[renderer muteAudio];
8[renderer unmuteAudio];

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

1@import PhenixSdk;
2
3// Previously obtained from media stream and started
4id<PhenixRenderer> renderer = ...;
5
6[renderer setDataQualityChangedCallback:
7    ^(id<PhenixRenderer> renderer,
8      PhenixDataQualityStatus status,
9      PhenixDataQualityReason reason) {
10        // Inform user, take action based on status and reason
11    }];
12
13// Previously obtained via PCast.publish
14id<PhenixPublisher> publisher = ...;
15
16[publisher setDataQualityChangedCallback:
17    ^(id<PhenixPublisher> publisher,
18      PhenixDataQualityStatus status,
19      PhenixDataQualityReason reason) {
20        // Inform user, take action based on status and reason
21    }];

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