Netzyn Player API for iOS

The Netzyn Player API for iOS allows an iOS application to embed the NZ Player functionality. This is accomplished by

• Adding NetzynPlayer.xcframework to your app
• Creating and adding NetzynPlayerviewController to your UIViewController, and add its corresponding view to your view hierarchy

The Netzyn Player SDK for iOS requires XCode 15 or later and iOS 16.2 or later.

Class NetzynPlayerViewController

This is the main UIKit class for the SDK. (For the SwiftUI View, see below). Add this view controller to your view controller hierarchy, and add its corresponding view to the view hierarchy.

When the last strong reference to NetzynPlayerViewController and its corresponding view is removed, the class is deallocated and the SDK will disconnect automatically.

Initializers

init(configuration:)

Creates a new instance with the specified configuration. This initializer constructs the view controller with the supplied configuration, and it will connect automatically.

NetzynPlayerViewController(configuration: Configuration)

Parameters:

configuration Configuration to connect the NetzynPlayerViewController

Example:

import UIKit
import NetzynPlayer

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        var configuration = Configuration(url: URL(string: "example.com")!)
        //adjust configuration as needed 

        let playerViewController = NetzynPlayerViewController(configuration: configuration)
        addChild(playerViewController)
        view.addSubview(playerViewController.view)
        playerViewController.view.translatesAutoresizingMaskIntoConstraints = false
        NSLayoutConstraint.activate([
            playerViewController.view.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
            playerViewController.view.bottomAnchor.constraint(equalTo: view.safeAreaLayoutGuide.bottomAnchor),
            playerViewController.view.leadingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.leadingAnchor),
            playerViewController.view.trailingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.trailingAnchor)
        ])
    }
}

Currently only one simultaneous instance of NetzynPlayerViewController is supported.

init(coder:)

Called when unarchiving the view controller from a storyboard or nib file. Do not call this initializer yourself, instead rely on it to be called automatically during the unarchive process. When the view controller is unarchived from a storyboard or nib file, it is not possible to provide a configuration at that time. Instead, you can provide a configuration later in the lifecycle with the setConfiguration(configuration:) method.

NetzynPlayerViewController(coder: NSCoder)

Currently only one simultaneous instance of NetzynPlayerViewController is supported.

Methods

setConfiguration(configuration:)

Provides a configuration 'late'. In the case that the NetzynPlayerViewController is constructed via init(coder:), for example, because it is unarchived from a storyboard file or a xib, no configuration is provided at initialization time. If so, this method can provide a configuration after the view controller is created. Once supplied with a configuration, connection can proceed automatically.

func setConfiguration(configuration: Configuration) async

Parameters:

configuration The configuration to set

Precondition:

No configuration has been provided to the NetzynPlayerViewController. That is, neither init(configuration:) nor setConfiguration(configuration:) have been previously called on this instance.

Properties

errors

Returns an ErrorSequence of errors. You can iterate over this sequence with for await error in errors.

var errors: ErrorSequence

presentErrors

Whether errors ought to be presented automatically to the user. If true, errors will be presented as alerts. true is the default value.

var presentErrors: Bool = true

Class NetzynPlayerView

This is the main SwiftUI class for the SDK. (For the UIKit ViewController, see above). Add this view type to your SwiftUI hierarchy.

!!! Note "When the NetzynPlayerView is removed from the view hierarchy, the SDK is deallocated and it will disconnect automatically.

init(configuration:)

Creates a new instance with the specified configuration. This initializer constructs the SwiftUI view with the supplied configuration, and it will connect automatically.

NetzynPlayerView(configuration: Configuration)

Parameters:

configuration Configuration to connect the NetzynPlayerView

Currently only one simultaneous instance of NetzynPlayerView is supported.

pause

Call this function to pause the NZPlayer. Typically this should be called when transitioning to the background.

void pause()

resume

Call this function to resume the NZPlayer. Typically this should be called when transitioning to the foreground.

void resume()

sendKeyDown

This function is called to send a keyboard key down event

sendKeyDown(int keycode, int metaState)

Parameters
keycode	Key event code from Key Codes
metaState	Meta key state flags from Meta State

sendKeyUp

This function is called to send a keyboard key up event

sendKeyUp(int keycode, int metaState)

Parameters
keycode	Key event code from Key Codes
metaState	Meta key state flags from Meta State

SwiftUI View Effects

presentingErrors

Whether errors ought to be presented automatically to the user. If true, errors will be presented as alerts. true is the default value.

func presentingErrors(_ value: Bool) -> NetzynPlayerView

withErrors

Returns an ErrorSequence of errors. You can iterate over this sequence with for await error in errors.

func withErrors(_ callback: @escaping (ErrorSequence) -> Void) -> NetzynPlayerView

Struct Configuration

A Configuration models the information needed to connect to the Netzyn Cloud.

Initializers

init(url:commandLineArgs:)

Creates the configuration with the specified parameters.

Configuration(url: URL, commandLineArgs: String = "")

Parameters:

url The URL to connect to. Please contact support@netzyn.com to get a provisioned cloud URL. To run a specific app, append the app name to the URL path. For example, example.com/specificappname.

commandLineArgs Additional low-level options to be passed to the SDK core. Supports many debugging and configuration options not directly exposed to the Swift API.

Properties

prefersMetalRenderer

When true, attempts to use the metal renderer. When false, uses the OpenGL renderer. The default value is true.

var prefersMetalRenderer: Bool = true

The Metal renderer is the modern high-performance default renderer for Apple platforms. To use the legacy OpenGL renderer instead, set this property to false.

!!! In the future, the legacy OpenGL renderer – and this API – will be removed. If you encounter bugs that require use of this property, please report them.

ErrorSequence

An opaque AsyncSequence of Swift.Error. To observe the errors produced by the SDK, use the for try await pattern.

Example:

//maintaining a weak reference ensures the viewcontroller does not remain allocated merely because of error handling
Task { [weak netzynPlayerViewController] in
    for try await error in netzynPlayerViewController?.errors {
        print("error")
    }
}

See also: NetzynPlayerViewController.presentsErrors.

Constants

Meta State

QZ_KEY_FLAGS_NONE
QZ_KEY_FLAGS_NUMLOCK	QZ_KEY_FLAGS_CAPSLOCK	QZ_KEY_FLAGS_LOCKS
QZ_KEY_FLAGS_ALT_RIGHT	QZ_KEY_FLAGS_ALT_LEFT	QZ_KEY_FLAGS_ALT
QZ_KEY_FLAGS_CTRL_RIGHT	QZ_KEY_FLAGS_CTRL_LEFT	QZ_KEY_FLAGS_CTRL
QZ_KEY_FLAGS_SHIFT_RIGHT	QZ_KEY_FLAGS_SHIFT_LEFT	QZ_KEY_FLAGS_SHIFT
QZ_KEY_FLAGS_META_LEFT	QZ_KEY_FLAGS_META_RIGHT	QZ_KEY_FLAGS_META
QZ_KEY_FLAGS_TRANSLATED	QZ_KEY_FLAGS_RELAY_KEY	QZ_KEY_FLAGS_AUTO_REPEAT

Key Codes

QZ_KEY_AACUTE	QZ_KEY_ACIRCUMFLEX	QZ_KEY_ACUTE	QZ_KEY_ADDFAVORITE
QZ_KEY_ADIAERESIS	QZ_KEY_AE	QZ_KEY_AGRAVE	QZ_KEY_ALTGR
QZ_KEY_ALT_LEFT	QZ_KEY_ALT_RIGHT	QZ_KEY_APP_HOME	QZ_KEY_APPLICATIONLEFT
QZ_KEY_APPLICATIONRIGHT	QZ_KEY_APP_RECENT	QZ_KEY_ARING	QZ_KEY_ATILDE
QZ_KEY_AUDIOCYCLETRACK	QZ_KEY_AUDIOFORWARD	QZ_KEY_AUDIORANDOMPLAY	QZ_KEY_AUDIOREPEAT
QZ_KEY_AWAY	QZ_KEY_BACK	QZ_KEY_BACKFORWARD	QZ_KEY_BACKSPACE
QZ_KEY_BACKTAB	QZ_KEY_BASSBOOST	QZ_KEY_BASSDOWN	QZ_KEY_BASSUP
QZ_KEY_BATTERY	QZ_KEY_BLUETOOTH	QZ_KEY_BOOK	QZ_KEY_BRIGHTNESSADJUST
QZ_KEY_BROKENBAR	QZ_KEY_CALCULATOR	QZ_KEY_CALENDAR	QZ_KEY_CALL
QZ_KEY_CAMERA	QZ_KEY_CAMERAFOCUS	QZ_KEY_CANCEL	QZ_KEY_CAPSLOCK
QZ_KEY_CCEDILLA	QZ_KEY_CD	QZ_KEY_CEDILLA	QZ_KEY_CENT
QZ_KEY_CHANNEL_DOWN	QZ_KEY_CHANNEL_UP	QZ_KEY_CLEAR	QZ_KEY_CLEARGRAB
QZ_KEY_CLOSE	QZ_KEY_CODEINPUT	QZ_KEY_COMMUNITY	QZ_KEY_COMPOSE
QZ_KEY_CONTEXT1	QZ_KEY_CONTEXT2	QZ_KEY_CONTEXT3	QZ_KEY_CONTEXT4
QZ_KEY_CONTRASTADJUST	QZ_KEY_COPY	QZ_KEY_COPYRIGHT	QZ_KEY_CTRL_LEFT
QZ_KEY_CTRL_RIGHT	QZ_KEY_CURRENCY	QZ_KEY_CUT	QZ_KEY_DEAD_ABOVEDOT
QZ_KEY_DEAD_ABOVERING	QZ_KEY_DEAD_ACUTE	QZ_KEY_DEAD_BELOWDOT	QZ_KEY_DEAD_BREVE
QZ_KEY_DEAD_CARON	QZ_KEY_DEAD_CEDILLA	QZ_KEY_DEAD_CIRCUMFLEX	QZ_KEY_DEAD_DIAERESIS
QZ_KEY_DEAD_DOUBLEACUTE	QZ_KEY_DEAD_GRAVE	QZ_KEY_DEAD_HOOK	QZ_KEY_DEAD_HORN
QZ_KEY_DEAD_IOTA	QZ_KEY_DEAD_MACRON	QZ_KEY_DEAD_OGONEK	QZ_KEY_DEAD_SEMIVOICED_SOUND
QZ_KEY_DEAD_TILDE	QZ_KEY_DEAD_VOICED_SOUND	QZ_KEY_DEGREE	QZ_KEY_DELETE
QZ_KEY_DEVICE_DISCONNECT	QZ_KEY_DIAERESIS	QZ_KEY_DISPLAY	QZ_KEY_DISPLAY_NERD_BOX
QZ_KEY_DIVISION	QZ_KEY_DOCUMENTS	QZ_KEY_DOS	QZ_KEY_DOWN
QZ_KEY_EACUTE	QZ_KEY_ECIRCUMFLEX	QZ_KEY_EDIAERESIS	QZ_KEY_EGRAVE
QZ_KEY_EISU_SHIFT	QZ_KEY_EISU_TOGGLE	QZ_KEY_EJECT	QZ_KEY_END
QZ_KEY_ENTER	QZ_KEY_ESC	QZ_KEY_ETH	QZ_KEY_EXCEL
QZ_KEY_EXCLAMDOWN	QZ_KEY_EXECUTE	QZ_KEY_EXIT	QZ_KEY_EXPLORER
QZ_KEY_F1	QZ_KEY_F2	QZ_KEY_F3	QZ_KEY_F4
QZ_KEY_F5	QZ_KEY_F6	QZ_KEY_F7	QZ_KEY_F8
QZ_KEY_F9	QZ_KEY_F10	QZ_KEY_F11	QZ_KEY_F12
QZ_KEY_F13	QZ_KEY_F14	QZ_KEY_F15	QZ_KEY_F16
QZ_KEY_F17	QZ_KEY_F18	QZ_KEY_F19	QZ_KEY_F20
QZ_KEY_F21	QZ_KEY_F22	QZ_KEY_F23	QZ_KEY_F24
QZ_KEY_F25	QZ_KEY_F26	QZ_KEY_F27	QZ_KEY_F28
QZ_KEY_F29	QZ_KEY_F30	QZ_KEY_F31	QZ_KEY_F32
QZ_KEY_F33	QZ_KEY_F34	QZ_KEY_F35	QZ_KEY_FAVORITES
QZ_KEY_FFWD	QZ_KEY_FINANCE	QZ_KEY_FLICKDOWN	QZ_KEY_FLICKLEFT
QZ_KEY_FLICKRIGHT	QZ_KEY_FLICKUP	QZ_KEY_FLIP	QZ_KEY_FORWARD
QZ_KEY_GAME	QZ_KEY_GO	QZ_KEY_GUILLEMOTLEFT	QZ_KEY_GUILLEMOTRIGHT
QZ_KEY_HANGUL	QZ_KEY_HANGUL_BANJA	QZ_KEY_HANGUL_END	QZ_KEY_HANGUL_HANJA
QZ_KEY_HANGUL_JAMO	QZ_KEY_HANGUL_JEONJA	QZ_KEY_HANGUL_POSTHANJA	QZ_KEY_HANGUL_PREHANJA
QZ_KEY_HANGUL_ROMAJA	QZ_KEY_HANGUL_SPECIAL	QZ_KEY_HANGUL_START	QZ_KEY_HANGUP
QZ_KEY_HANKAKU	QZ_KEY_HELP	QZ_KEY_HENKAN	QZ_KEY_HIBERNATE
QZ_KEY_HIRAGANA	QZ_KEY_HIRAGANA_KATAKANA	QZ_KEY_HISTORY	QZ_KEY_HOME
QZ_KEY_HOMEPAGE	QZ_KEY_HOTLINKS	QZ_KEY_HYPHEN	QZ_KEY_IACUTE
QZ_KEY_ICIRCUMFLEX	QZ_KEY_IDIAERESIS	QZ_KEY_IGRAVE	QZ_KEY_INSERT
QZ_KEY_ITOUCH	QZ_KEY_KANA_LOCK	QZ_KEY_KANA_SHIFT	QZ_KEY_KANJI
QZ_KEY_KATAKANA	QZ_KEY_KEYBOARDBRIGHTNESSDOWN	QZ_KEY_KEYBOARDBRIGHTNESSUP	QZ_KEY_KEYBOARDLIGHTONOFF
QZ_KEY_LAST	QZ_KEY_LASTNUMBERREDIAL	QZ_KEY_LAUNCH0	QZ_KEY_LAUNCH1
QZ_KEY_LAUNCH2	QZ_KEY_LAUNCH3	QZ_KEY_LAUNCH4	QZ_KEY_LAUNCH5
QZ_KEY_LAUNCH6	QZ_KEY_LAUNCH7	QZ_KEY_LAUNCH8	QZ_KEY_LAUNCH9
QZ_KEY_LAUNCHA	QZ_KEY_LAUNCHB	QZ_KEY_LAUNCHC	QZ_KEY_LAUNCHD
QZ_KEY_LAUNCHE	QZ_KEY_LAUNCHF	QZ_KEY_LAUNCHG	QZ_KEY_LAUNCHH
QZ_KEY_LAUNCHMAIL	QZ_KEY_LAUNCHMEDIA	QZ_KEY_LEFT	QZ_KEY_LIGHTBULB
QZ_KEY_LOGOFF	QZ_KEY_MACRON	QZ_KEY_MAILFORWARD	QZ_KEY_MARKET
QZ_KEY_MASCULINE	QZ_KEY_MASSYO	QZ_KEY_MEDIA_LAST	QZ_KEY_MEDIA_LOOP_OFF
QZ_KEY_MEDIA_LOOP_ON	QZ_KEY_MEDIA_LOOP_TOGGLE	QZ_KEY_MEDIA_NEXT	QZ_KEY_MEDIA_PAUSE
QZ_KEY_MEDIA_PREVIOUS	QZ_KEY_MEDIA_SKIP_BACK	QZ_KEY_MEDIA_SKIP_FWD	QZ_KEY_MEDIA_START
QZ_KEY_MEDIA_STOP	QZ_KEY_MEDIA_TOGGLE_PLAY_PAUSE	QZ_KEY_MEETING	QZ_KEY_MEMO
QZ_KEY_MENU	QZ_KEY_MENUKB	QZ_KEY_MENUPB	QZ_KEY_MESSENGER
QZ_KEY_META_LEFT	QZ_KEY_META_RIGHT	QZ_KEY_MODE_SWITCH	QZ_KEY_MONBRIGHTNESSDOWN
QZ_KEY_MONBRIGHTNESSUP	QZ_KEY_MOUSE_LOCK	QZ_KEY_MU	QZ_KEY_MUHENKAN
QZ_KEY_MULTI_KEY	QZ_KEY_MULTIPLECANDIDATE	QZ_KEY_MULTIPLY	QZ_KEY_MUSIC
QZ_KEY_MYSITES	QZ_KEY_NEWS	QZ_KEY_NO	QZ_KEY_NOBREAKSPACE
QZ_KEY_NOTSIGN	QZ_KEY_NTILDE	QZ_KEY_NUMLOCK	QZ_KEY_NUMPAD0
QZ_KEY_NUMPAD1	QZ_KEY_NUMPAD2	QZ_KEY_NUMPAD3	QZ_KEY_NUMPAD4
QZ_KEY_NUMPAD5	QZ_KEY_NUMPAD6	QZ_KEY_NUMPAD7	QZ_KEY_NUMPAD8
QZ_KEY_NUMPAD9	QZ_KEY_NUMPAD_COMMA	QZ_KEY_NUMPAD_DECIMAL	QZ_KEY_NUMPAD_DIVIDE
QZ_KEY_NUMPAD_ENTER	QZ_KEY_NUMPAD_MINUS	QZ_KEY_NUMPAD_MULTIPLY	QZ_KEY_NUMPAD_PLUS
QZ_KEY_OACUTE	QZ_KEY_OCIRCUMFLEX	QZ_KEY_ODIAERESIS	QZ_KEY_OFFICEHOME
QZ_KEY_OGRAVE	QZ_KEY_ONEHALF	QZ_KEY_ONEQUARTER	QZ_KEY_ONESUPERIOR
QZ_KEY_OOBLIQUE	QZ_KEY_OPENURL	QZ_KEY_OPTION	QZ_KEY_ORDFEMININE
QZ_KEY_OTILDE	QZ_KEY_PAGE_DOWN	QZ_KEY_PAGE_UP	QZ_KEY_PARAGRAPH
QZ_KEY_PASTE	QZ_KEY_PAUSE	QZ_KEY_PERIODCENTERED	QZ_KEY_PHONE
QZ_KEY_PICTURES	QZ_KEY_PLAY	QZ_KEY_PLUSMINUS	QZ_KEY_POWERDOWN
QZ_KEY_POWEROFF	QZ_KEY_PREVIOUSCANDIDATE	QZ_KEY_PRINTER	QZ_KEY_PRINT_SCREEN
QZ_KEY_PROG_BLUE	QZ_KEY_PROG_GREEN	QZ_KEY_PROG_RED	QZ_KEY_PROG_YELLOW
QZ_KEY_PROPS	QZ_KEY_QUESTIONDOWN	QZ_KEY_RECORD	QZ_KEY_REFRESH
QZ_KEY_REGISTERED	QZ_KEY_RELOAD	QZ_KEY_REMOTE_LAUNCH_DISABLE	QZ_KEY_REMOTE_LAUNCH_ENABLE
QZ_KEY_REMOTE_LAUNCH_TOGGLE	QZ_KEY_REPLY	QZ_KEY_RETURN	QZ_KEY_REWIND
QZ_KEY_RIGHT	QZ_KEY_ROMAJI	QZ_KEY_ROTATEWINDOWS	QZ_KEY_ROTATIONKB
QZ_KEY_ROTATIONPB	QZ_KEY_SAVE	QZ_KEY_SCALE	QZ_KEY_SCREENSAVER
QZ_KEY_SCROLLOCK	QZ_KEY_SEARCH	QZ_KEY_SECTION	QZ_KEY_SELECT
QZ_KEY_SEND	QZ_KEY_SHIFT_LEFT	QZ_KEY_SHIFT_RIGHT	QZ_KEY_SHOP
QZ_KEY_SHUTDOWN	QZ_KEY_SINGLECANDIDATE	QZ_KEY_SLEEP	QZ_KEY_SPACE
QZ_KEY_SPELL	QZ_KEY_SPLITSCREEN	QZ_KEY_SSHARP	QZ_KEY_STANDBY
QZ_KEY_STERLING	QZ_KEY_STOP	QZ_KEY_SUBTITLE	QZ_KEY_SUPPORT
QZ_KEY_SUSPEND	QZ_KEY_TAB	QZ_KEY_TASKPANE	QZ_KEY_TERMINAL
QZ_KEY_THORN	QZ_KEY_THREEQUARTERS	QZ_KEY_THREESUPERIOR	QZ_KEY_TIME
QZ_KEY_TODOLIST	QZ_KEY_TOGGLECALLHANGUP	QZ_KEY_TOGGLE_CURSOR	QZ_KEY_TOGGLE_VIDEO_444
QZ_KEY_TOGGLE_VIDEO_ALPHA	QZ_KEY_TOGGLE_VIDEO_FPS	QZ_KEY_TOGGLE_VIDEO_HQ	QZ_KEY_TOOLS
QZ_KEY_TOPMENU	QZ_KEY_TOUROKU	QZ_KEY_TRANSFER_APP	QZ_KEY_TRANSFER_APP_TO_DESKTOP
QZ_KEY_TRANSFER_APP_TO_PHONE	QZ_KEY_TRANSFER_APP_TO_TV	QZ_KEY_TRAVEL	QZ_KEY_TREBLEDOWN
QZ_KEY_TREBLEUP	QZ_KEY_TWOSUPERIOR	QZ_KEY_UACUTE	QZ_KEY_UCIRCUMFLEX
QZ_KEY_UDIAERESIS	QZ_KEY_UGRAVE	QZ_KEY_UNDO	QZ_KEY_UP
QZ_KEY_UWB	QZ_KEY_VIDEO	QZ_KEY_VIEW	QZ_KEY_VIRTUAL_KBD_AVAILABLE1
QZ_KEY_VIRTUAL_KBD_AVAILABLE2	QZ_KEY_VIRTUAL_KBD_HIDE	QZ_KEY_VIRTUAL_KBD_MOVE	QZ_KEY_VIRTUAL_KBD_MOVE_APP
QZ_KEY_VIRTUAL_KBD_SHOW	QZ_KEY_VIRTUAL_KBD_TOGGLE	QZ_KEY_VOICEDIAL	QZ_KEY_VOLUME_DOWN
QZ_KEY_VOLUMEMUTE	QZ_KEY_VOLUME_MUTE_OFF	QZ_KEY_VOLUME_MUTE_ON	QZ_KEY_VOLUME_MUTE_TOGGLE
QZ_KEY_VOLUME_UP	QZ_KEY_WAKEUP	QZ_KEY_WEBCAM	QZ_KEY_WLAN
QZ_KEY_WORD	QZ_KEY_WWW	QZ_KEY_XFER	QZ_KEY_YACUTE
QZ_KEY_YDIAERESIS	QZ_KEY_YEN	QZ_KEY_YES	QZ_KEY_ZENKAKU
QZ_KEY_ZENKAKU_HANKAKU	QZ_KEY_ZOOM	QZ_KEY_ZOOMIN	QZ_KEY_ZOOMOUT