-
- All Implemented Interfaces:
-
com.hyprmx.android.sdk.core.HyprMXMediation
public interface HyprMXIf implements HyprMXMediation
This represents the interface to interact with the HyprMX SDK
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceHyprMXIf.HyprMXInitializationListenerThe initialization listener.
When provided, HyprMX will callback to initializationComplete when initialization has completed successfully. HyprMX will callback to initializationFailed when there was a problem initializing. If there was a problem initializing, check the logs for more details on the failure.
public interfaceHyprMXIf.HyprMXAudioAdListenerThe Audio Ad listener.
When provided, HyprMX will callback to onAdAudioStart when an Audio ad has requested the audio stream. HyprMX will callback to onAdAudioEnd when the audio ad has completed audio.
The application listening to these event should pause their MEDIA stream on onAdAudioStart and resume on onAdAudioEnd
-
Method Summary
Modifier and Type Method Description abstract Unitinitialize(Context context, String distributorId, String userId, HyprMXIf.HyprMXInitializationListener listener)context The context distributorId The distribution id provided to you by HyprMX. abstract Unitinitialize(Context context, String distributorId, String userId, ConsentStatus consentStatus, HyprMXIf.HyprMXInitializationListener listener)context The context distributorId The distribution id provided to you by HyprMX. abstract Unitinitialize(Context context, String distributorId, String userId, ConsentStatus consentStatus, Boolean ageRestrictedUser, HyprMXIf.HyprMXInitializationListener listener)context The context distributorId The distribution id provided to you by HyprMX. abstract PlacementgetPlacement(String placementName)Gets the placement for the given name. abstract HyprMXStategetInitializationState()Gets the HyprMX initialization state. abstract UnitsetConsentStatus(ConsentStatus consentStatus)Sets the GDPR consent status. abstract Set<Placement>getPlacements()Gets list of all available placements. abstract StringsessionToken()Retrieves the bidding session token. abstract UnitsetAudioAdListener(HyprMXIf.HyprMXAudioAdListener listener)listener Set the HyprMX Audio Ad Listener. -
-
Method Detail
-
initialize
abstract Unit initialize(Context context, String distributorId, String userId, HyprMXIf.HyprMXInitializationListener listener)
context The context distributorId The distribution id provided to you by HyprMX. userId A unique identifier supplied by your application and should be static for each user across sessions. listener The HyprMX Initialization Listener. HyprMX will callback to this when initialization is complete
-
initialize
abstract Unit initialize(Context context, String distributorId, String userId, ConsentStatus consentStatus, HyprMXIf.HyprMXInitializationListener listener)
context The context distributorId The distribution id provided to you by HyprMX. userId A unique identifier supplied by your application and should be static for each user across sessions. consentStatus The consent status of GDPR. listener The HyprMX Initialization Listener. HyprMX will callback to this when initialization is complete
-
initialize
abstract Unit initialize(Context context, String distributorId, String userId, ConsentStatus consentStatus, Boolean ageRestrictedUser, HyprMXIf.HyprMXInitializationListener listener)
context The context distributorId The distribution id provided to you by HyprMX. userId A unique identifier supplied by your application and should be static for each user across sessions. consentStatus The consent status of GDPR. ageRestrictedUser Indicates if the user should be handled as Age Restricted. listener The HyprMX Initialization Listener. HyprMX will callback to this when initialization is complete
-
getPlacement
abstract Placement getPlacement(String placementName)
Gets the placement for the given name.
-
getInitializationState
abstract HyprMXState getInitializationState()
Gets the HyprMX initialization state.
-
setConsentStatus
abstract Unit setConsentStatus(ConsentStatus consentStatus)
Sets the GDPR consent status.
-
getPlacements
abstract Set<Placement> getPlacements()
Gets list of all available placements.
-
sessionToken
abstract String sessionToken()
Retrieves the bidding session token. May return null if HyprMX is not initialized
-
setAudioAdListener
abstract Unit setAudioAdListener(HyprMXIf.HyprMXAudioAdListener listener)
listener Set the HyprMX Audio Ad Listener. HyprMX will callback to this anytime the Audio Ad state changes
-
-
-
-