Integration Essentials

this section details the configuration process for the nativewaves sdk, focusing on three critical components the graphical user interface (gui) overlay, content provider urls, and synchronization settings the gui overlay configures the user interface layer, enhancing user interaction and information display the content provider url specifies the source for streaming content lastly, synchronization settings ensure that the app's content is in sync with the user's viewing experience, with options for required, optional, or no synchronization together, these settings are fundamental in customizing and optimizing the nativewaves experience in your application dynamic orientation and system ui handling for an enhanced viewing experience, once you open the exp view, you can switch to landscape mode and hide the system ui improve user experience by dynamically managing screen orientation and system ui visibility in jetpack compose, incorporating configuration changes to handle device orientation and ui mode changes seamlessly handling config changes in androidmanifest specify configuration changes in your activity declaration within androidmanifest xml to prevent activity restarts on these changes \<activity android\ name=" mainactivity" android\ configchanges="orientation|screensize|screenlayout|uimode|smallestscreensize|locale"> \<! other activity configurations > \</activity> adjusting ui overlays and orientation in your composable function, you can define orientation properties and set the currentroute if you're utilizing navigation, as demonstrated in the following code snippet val navcontroller = remembernavcontroller() val orientation = localconfiguration current orientation val activity = localcontext current as activity val currentroute = currentroute(navcontroller = navcontroller) ui overlays based on orientation toggle system ui overlays visibility based on the device's orientation to enhance immersion or provide necessary controls launchedeffect(orientation) { if (orientation == configuration orientation landscape) { systemuiutils hidesystemuioverlay(activity) // app layer function } else { systemuiutils showsystemuioverlay(activity) // app layer function } } orientation based on navigation route adjust the screen orientation based on the current route, catering to specific content presentation needs launchedeffect(currentroute) { if (currentroute? contains(tag exp view) == true) { activity requestedorientation = activityinfo screen orientation sensor landscape } else { activity requestedorientation = activityinfo screen orientation portrait } } notes tag exp view is a placeholder for navigation routes requiring landscape mode properly managing config changes and specifying them in the manifest helps in maintaining the application state and user context during orientation changes or when other specified config changes occur this approach enables your jetpack compose application to dynamically adapt to device orientation changes and user navigation, ensuring an optimal user experience while efficiently handling configuration changes gui overlay the gui overlay in nwexp for android and ios is a dynamic, web based interface layer that changes based on settings in the nativewaves console and the type of event viewed the url for this overlay is set by the app using a specific function in the sdk, allowing customization of the user interface to match the event's context and content by default, the url for the web layer is set by the app for this, the following property is available var guioverlayurl string = "\<guioverlayurl>" coresdk guioverlayurl = guioverlayurl the communication with the web layer is done using a coresdkui interface which calls and receives certain events the interface is being described in the api reference docid\ kyuedy2o5bi5lp9 ht5gz content provider (optional) the content provider in the nativewaves sdk is a critical component that specifies the source url for the content associated with a nativewaves experience (nwexp) this url is used to fetch and stream the content relevant to the specified experience, ensuring that users have access to the intended media or event set by the application, this url links the sdk to the appropriate content source, facilitating seamless content delivery and playback within the app by default, the url for the content provider is set by the app for this, the following property is available var contentproviderurl string = "\<contentproviderurl>" coresdk contentproviderurl = contentproviderurl audio sync configuration the nativewaves sdk provides a flexible audio synchronization configuration to align the app's content with the user's viewing experience the syncconfig setting determines how synchronization is managed within the sdk syncconfig settings no sync no synchronization data is required use this setting when sync is not a part of the user experience sync optional and sync only synchronization data is required these settings are used when the app needs to synchronize content with the user's viewing experience if developer uses sync optional and sync only it required some properties to initialize the syncconfig object required parameters smdsendpoint a mandatory endpoint for synchronization data audiosyncmode required set to channel (default) or library if not explicitly set to library , the default is channel ensure to reset this value when switching, for example, to another showcase libraryid essential for content synchronization optional parameters directsyncid optional, but required if audiosyncmode is set to library channelid optional example configuration in code val enablesync = true // for now, this flag is true by default val libraryid = "\<libraryid>" val directsyncid string? = "\<directsyncid>" val smdsendpoint nwsmdsendpoint? = nwsmdsendpoint("\<groupid>", "\<url>") // configure the synchronization settings val synccontents = synccontents( syncconfig = syncconfig, smdsendpoint = smdsendpoint, libraryid = libraryid, directsyncid = directsyncidnullable, audiosyncmode = audiosyncmode, ) val audiosyncservice = coresdk audiosyncservice( expmanifestid = expmanifestid, synccontents = synccontents ) val expplayback = this experienceplaybackservice( expmanifestid = expmanifestid, audiosyncservice = audiosyncservice, // to enable audio sync, you have to add this service during initilize experience playback service ) key components manifest and library identifiers expmanifestid a unique identifier for the experience manifest, essential for fetching the correct multimedia content libraryid identifies the content library, assisting in content organization and retrieval synchronization parameters directsyncid specifies the identifier for direct synchronization, enabling precise alignment of multimedia content across different platforms or devices smdsendpoint configures the synchronization metadata service (smds) endpoint, which is crucial for fetching synchronization data gui overlay url an overlay url ( overlayurl ) is defined to act as the player's controller, offering additional information and controls over the multimedia content synchronization configuration determines whether synchronization is enabled ( enablesync ) and configures the synchronization settings ( syncconfig ) accordingly establishes the audio synchronization mode ( audiosyncmode ), which can vary based on the availability and type of synchronization endpoint synchronization contents object constructs a synccontents object with the previously defined synchronization parameters, including the direct synchronization identifier, smds endpoint, library identifier, and audio sync mode nwcore sdk configuration sets the sdk environment to production ( nwenvironment prod ) and specifies the locale initializes the audio synchronization service with the experience manifest id and the configured synchronization contents experience playback service initialization utilizes the audiosyncservice to initialize the experienceplaybackservice , which is responsible for managing the multimedia content playback the synchronization configuration is crucial for a seamless and synchronized user experience ensure the appropriate sync settings are used based on the application's requirements and the type of content being served localization configuration the nativewaves sdk offers localization support by allowing the application to set a specific language code this feature enables the app to cater to a diverse user base by presenting content in the user's preferred language default behavior the sdk defaults to the system's locale if the system's language isn't supported, it defaults to english ( 'en' ) currently, supports english ( 'en' ) and german ( 'de' ) setting language use locale string to set the desired language ( 'en' or 'de' ) if the app requires only the german language ( 'de' ), here is the code snippet to set the locale nwcoresdk locale = "de" // sets the language to german environment type configuration the nativewaves sdk allows setting the environment type to align with different stages of development and deployment this is crucial for testing and production purposes default environment production ( prod ) is the default development ( dev ) and testing ( test ) environments are also available accessing dev/test contact nativewaves support for dev or test environment access the sdk auto detects the environment test for debug builds, prod otherwise setting environment use environment environmenttype to set the desired environment if the developers want to try with dev or test environment, here is the code snippet to set the locale / enum class environmenttype { dev, test, prod; } / nwcoresdk environment = environmenttype prod // sets the environment to production environmenttype enum description &#x9;• prod the production environment, offering the highest stability and reliability for public use &#x9;• test a pre production environment, quite stable and almost ready for deployment in the production environment &#x9;• dev the development environment, where stability is not guaranteed and features may be in experimental stages