SmartclipSDKiOS 3.0.0
Smartclip Advertisement Framework for iOS
Loading...
Searching...
No Matches
Instance Methods | Properties | List of all members
SCAdSlotController Class Reference

The SCAdSlotController initializes and controls a single AdSlot. A valid SCAdSlotController must be inialized from the SCAdSessionController. More...

#import <SCAdSlotController.h>

Inheritance diagram for SCAdSlotController:
<SCPlayerEventListener>

Instance Methods

(void) - startAdSlotWith:
 
(void) - startVMAPWith:
 
(void) - stopAdPlaylist
 Call this function to stop a VMAP playlist.
 
(void) - stopAdSlot
 Call this function if you want to stop and active adSlot (before it ends by itself)
 
(void) - skipAd
 Call this function if you want to skip an adSlot.
 
(void) - cleanup
 Cleanup after usage!
 
(void) - playerEventCallbackWith:
 Callback function for the video player that must be called for certain player events. More...
 
(void) - getAdInfo:
 Call this function for a more detailed adInfo.
 
(void) - getPublicAdSlot:
 Call this function for a more detailed adInfo.
 
(void) - onClickThrough
 Call this function when the user taps on the adView and clickthrough is active.
 
(void) - addVisibilityCheckerForView:
 Add your adView for visibility checks with this function.
 
(void) - registerFriendlyViews:
 Register any view, that covers your adView but belongs to your ad playback views (like soundButton, replayButton etc.)
 
(void) - pausePlayback
 Call this function if you want to pause playback.
 
(void) - startPlayback
 Call this function if you want to start playback.
 
(void) - resumePlayback
 Call this function if you want to resume playback.
 
(void) - setFriendlyViews:
 
(void) - onBufferEmpty
 Call this function, if while streaming an ad the player stops due to an empty buffer. More...
 
(void) - onBufferRefilled
 
(void) - getAdError:
 Call this function for a detailed adError error description.
 
(void) - setOmidEventLoggingDelegate:
 :nodoc:
 
(void) - loadAdSuccess
 Call this function if the loading of the adTag succeeded. More...
 
(void) - loadAdFailure
 Call this function if the loading of the adTag failed. More...
 
(void) - unmutePlayer
 Call this function to unmute the adPlayer.
 
(void) - mutePlayer
 Call this function to mute the adPlayer.
 
(BOOL) - isMuted
 Call this function to check if the player currently is muted.
 
(void) - clickTroughURL:
 
(void) - resize
 Call this function when your video player has changed its size. More...
 
- Instance Methods inherited from <SCPlayerEventListener>
(void) - playerEventCallbackWith:
 Inform adSlotController about the player state. More...
 
(void) - getAdInfo:
 DEPRECATED: This function must no longer be implemented by the listener.
 
(void) - getAdError:
 DEPRECATED: This function must no longer be implemented by the listener.
 
(void) - getPublicAdSlot:
 DEPRECATED: This function must no longer be implemented by the listener.
 
("This function must no longer be implemented by the listener") - __deprecated_msg
 DEPRECATED: This function must no longer be implemented by the listener.
 
(void) - onBufferEmpty
 Inform the adSlotController about an empty player buffer (needed for OMID) More...
 
(void) - onBufferRefilled
 Inform the adSlotController about a refilled player buffer (needed for OMID) More...
 
(void) - loadAdSuccess
 Inform the adSlotController about a successfull ad video load. More...
 
(void) - loadAdFailure
 Inform the adSlotController about an unsuccessfull ad video load. More...
 
("This function must no longer be implemented by the listener") - __deprecated_msg
 DEPRECATED: This function must no longer be implemented by the listener.
 
(void) - resize
 Call when presentationSize of the player changes. More...
 
(void) - contentVideoFinished
 Call when contentVideo has finished.
 
(void) - contentVideoError:
 Call when contentVideo has an error.
 

Properties

SCAdConfigurationconfiguration
 Readonly version of the SCAdConfiguration.
 
id< SCAdListeneradListener
 Register your adController as SCAdSlotControllerDelegate.
 

Detailed Description

The SCAdSlotController initializes and controls a single AdSlot. A valid SCAdSlotController must be inialized from the SCAdSessionController.

Method Documentation

◆ clickTroughURL:

- (void) clickTroughURL: (SCStringResultCompletionBlock)  completion

Please be aware that calling this function results in sending a click tracker! only use it in companion with a customizableClickThroughAlert, other implementations of clickThrough handling already send a click tracker, so calling this function in that situation results in multiple click trackers being sent.

◆ loadAdFailure

- (void) loadAdFailure

Call this function if the loading of the adTag failed.

Reimplemented from <SCPlayerEventListener>.

◆ loadAdSuccess

- (void) loadAdSuccess

Call this function if the loading of the adTag succeeded.

Reimplemented from <SCPlayerEventListener>.

◆ onBufferEmpty

- (void) onBufferEmpty

Call this function, if while streaming an ad the player stops due to an empty buffer.

Reimplemented from <SCPlayerEventListener>.

◆ onBufferRefilled

- (void) onBufferRefilled

Call this function, if the player can continue after the buffer was empty and is able to play on now

Reimplemented from <SCPlayerEventListener>.

◆ playerEventCallbackWith:

- (void) playerEventCallbackWith: (SCAdPlayerEventType)  playerEventType

Callback function for the video player that must be called for certain player events.

Reimplemented from <SCPlayerEventListener>.

◆ resize

- (void) resize

Call this function when your video player has changed its size.

Reimplemented from <SCPlayerEventListener>.

◆ setFriendlyViews:

- (void) setFriendlyViews: (NSMutableArray *)  friendlyViews

Add views that belong to the player (like soundbuttons etc.) and should not be registered as views that cover the adView

◆ startAdSlotWith:

- (void) startAdSlotWith: (SCAdConfiguration *)  configuration

You start the playback of an ad slot with this function

◆ startVMAPWith:

- (void) startVMAPWith: (SCAdConfiguration *)  configuration

You start the playback of VMAP playlist with this function


The documentation for this class was generated from the following file: