Class ACSVideoStreamRenderer

  • Article

Declaration

@interface ACSVideoStreamRenderer : NSObject;

Description

Renderer for video rendering

Methods

initWithLocalVideoStream

-(instancetype _Nonnull)initWithLocalVideoStream:(ACSLocalVideoStream*_Nonnull) localVideoStream
                                       withError:(NSError*_Nullable*_Nonnull) nonnull_error __attribute__((swift_error(nonnull_error)))

Parameters

  • localVideoStream - Local video stream information
  • nonnull_error - required to make this API throwable in Swift.

initWithRemoteVideoStream

-(instancetype _Nonnull)initWithRemoteVideoStream:(ACSRemoteVideoStream*_Nonnull) remoteVideoStream
                                        withError:(NSError*_Nullable*_Nonnull) nonnull_error __attribute__((swift_error(nonnull_error)))

Parameters

  • remoteVideoStream - Video stream on remote participant
  • nonnull_error - required to make this API throwable in Swift.

createView

-(ACSVideoStreamRendererView* _Nonnull)createView:(NSError*_Nullable*_Nonnull) nonnull_error __attribute__((swift_error(nonnull_error)));

Parameters

  • nonnull_error - required to make this API throwable in Swift.

Returns

  • ACSVideoStreamRendererView

createViewWithOptions

-(ACSVideoStreamRendererView* _Nonnull)createViewWithOptions:(ACSCreateViewOptions*_Nullable) options
                                        withError:(NSError*_Nullable*_Nonnull) error __attribute__((swift_error(nonnull_error)));

Parameters

  • options - ACSCreateViewOptions to set scaling mode of the video.
  • error - required to make this API throwable in Swift.

Returns

  • ACSVideoStreamRendererView

dispose

Dispose renderer and all RendererView associated with this renderer. To be called when you have removed all associated views from the UI.

-(void)dispose;

Properties

size

@property(readonly) struct ACSStreamSize size;

delegate

An object you provide to receive events from this ACSVideoStreamRenderer instance.

@property(nonatomic, assign, nullable) id<ACSVideoStreamRendererDelegate> delegate;