From 3c7fa11f8750dad594b0c06df85f2dd7e21d1abe Mon Sep 17 00:00:00 2001 From: Artem Yelizarov Date: Tue, 11 Jun 2024 14:58:16 +0300 Subject: [PATCH] Generate documentation after updates --- docs/data/documentation/playbacksdk.json | 2 +- .../tutorials/playbacksdk/getstarted.json | 639 +----------------- docs/data/tutorials/table-of-contents.json | 2 +- docs/documentation/playbacksdk/index.html | 2 +- docs/index.html | 2 +- docs/metadata.json | 2 +- docs/theme-settings.json | 7 - .../playbacksdk/getstarted/index.html | 2 +- docs/tutorials/table-of-contents/index.html | 2 +- 9 files changed, 8 insertions(+), 652 deletions(-) delete mode 100644 docs/theme-settings.json diff --git a/docs/data/documentation/playbacksdk.json b/docs/data/documentation/playbacksdk.json index 2b4493d..8526bb9 100644 --- a/docs/data/documentation/playbacksdk.json +++ b/docs/data/documentation/playbacksdk.json @@ -1 +1 @@ -{"metadata":{"role":"collection","symbolKind":"module","externalID":"PlaybackSDK","roleHeading":"Framework","title":"PlaybackSDK","modules":[{"name":"PlaybackSDK"}]},"identifier":{"url":"doc:\/\/PlaybackSDK\/documentation\/PlaybackSDK","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[[]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/playbacksdk"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://PlaybackSDK/documentation/PlaybackSDK":{"title":"PlaybackSDK","role":"collection","abstract":[],"type":"topic","kind":"symbol","url":"\/documentation\/playbacksdk","identifier":"doc:\/\/PlaybackSDK\/documentation\/PlaybackSDK"}}} \ No newline at end of file +{"kind":"symbol","metadata":{"modules":[{"name":"PlaybackSDK"}],"role":"collection","roleHeading":"Framework","externalID":"PlaybackSDK","symbolKind":"module","title":"PlaybackSDK"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/PlaybackSDK\/documentation\/PlaybackSDK"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/playbacksdk"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[[]]},"references":{"doc://PlaybackSDK/documentation/PlaybackSDK":{"role":"collection","kind":"symbol","url":"\/documentation\/playbacksdk","abstract":[],"type":"topic","identifier":"doc:\/\/PlaybackSDK\/documentation\/PlaybackSDK","title":"PlaybackSDK"}}} \ No newline at end of file diff --git a/docs/data/tutorials/playbacksdk/getstarted.json b/docs/data/tutorials/playbacksdk/getstarted.json index 1b4bd99..a00bc22 100644 --- a/docs/data/tutorials/playbacksdk/getstarted.json +++ b/docs/data/tutorials/playbacksdk/getstarted.json @@ -1,638 +1 @@ -{ - "sections": [ - { - "chapter": "Getting Started", - "estimatedTimeInMinutes": 30, - "title": "Playback SDK Overview", - "content": [ - { - "inlineContent": [ - { - "type": "text", - "text": "Playback SDK simplifies integrating video playback functionalities into OTT applications. It provides a unified interface for interacting with video APIs and managing playback logic." - } - ], - "type": "paragraph" - }, - { - "inlineContent": [ - { - "inlineContent": [ - { - "type": "text", - "text": "Key Features:" - } - ], - "type": "strong" - } - ], - "type": "paragraph" - }, - { - "items": [ - { - "content": [ - { - "type": "paragraph", - "inlineContent": [ - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "Abstraction:" - } - ] - }, - { - "text": " Hides the complexities of underlying video APIs, allowing you to focus on the core playback experience.", - "type": "text" - } - ] - } - ] - }, - { - "content": [ - { - "inlineContent": [ - { - "inlineContent": [ - { - "text": "Flexibility:", - "type": "text" - } - ], - "type": "strong" - }, - { - "type": "text", - "text": " Supports different video providers and allows the creation of custom playback plugins for extended functionalities." - } - ], - "type": "paragraph" - } - ] - }, - { - "content": [ - { - "inlineContent": [ - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "Error Handling:" - } - ] - }, - { - "type": "text", - "text": " Provides mechanisms to handle potential issues during playback and notify your application." - } - ], - "type": "paragraph" - } - ] - } - ], - "type": "unorderedList" - } - ], - "kind": "hero" - }, - { - "tasks": [ - { - "title": "Playback SDK", - "stepsSection": [ - { - "content": [ - { - "type": "paragraph", - "inlineContent": [ - { - "type": "strong", - "inlineContent": [ - { - "text": "Step 1:", - "type": "text" - } - ] - }, - { - "type": "text", - "text": " Initialize the Playback SDK by providing your API key and register the default player plugin." - }, - { - "type": "text", - "text": " " - }, - { - "inlineContent": [ - { - "text": "Make sure this step is done when the app starts.", - "type": "text" - } - ], - "type": "strong" - } - ] - } - ], - "caption": [], - "type": "step", - "media": null, - "code": "PlayBackDemoApp.swift", - "runtimePreview": null - }, - { - "content": [ - { - "type": "paragraph", - "inlineContent": [ - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "Step 2:" - } - ] - }, - { - "type": "text", - "text": "" - }, - { - "text": " ", - "type": "text" - }, - { - "type": "text", - "text": "Load the player using the Playback SDK and handle any playback errors." - } - ] - } - ], - "type": "step", - "media": null, - "code": "PlayerTestView.swift", - "runtimePreview": null, - "caption": [ - { - "type": "paragraph", - "inlineContent": [ - { - "type": "text", - "text": "In this step, the code utilizes the " - }, - { - "type": "strong", - "inlineContent": [ - { - "text": "loadPlayer", - "type": "text" - } - ] - }, - { - "type": "text", - "text": " function provided by the Playback SDK to initialize and load the video player. The function takes the entry ID and authorization token as parameters. Additionally, it includes a closure to handle any potential playback errors that may occur during the loading process." - }, - { - "type": "text", - "text": " " - }, - { - "type": "text", - "text": "The " - }, - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "handlePlaybackError" - } - ] - }, - { - "type": "text", - "text": " function is called within the closure to handle the playback errors. It switches on the type of error received and provides appropriate error handling based on the type of error encountered." - }, - { - "type": "text", - "text": " " - }, - { - "type": "text", - "text": "The code also includes a placeholder comment to indicate where the removal of the player could be implemented in the " - }, - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "onDisappear" - } - ] - }, - { - "type": "text", - "text": " modifier." - }, - { - "type": "paragraph", - "inlineContent": [ - { - "type": "text", - "text": "If you want to allow users to access free content or if you're implementing a guest mode, you can pass an empty string or " - }, - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "nil" - } - ] - }, - { - "type": "text", - "text": " value as the " - }, - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "authorizationToken" - } - ] - }, - { - "type": "text", - "text": " when calling the " - }, - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "loadPlayer" - } - ] - }, - { - "type": "text", - "text": " function. This will bypass the need for authentication, enabling unrestricted access to the specified content." - } - ] - } - ] - } - ] - }, - { - "content": [ - { - "type": "paragraph", - "inlineContent": [ - { - "type": "strong", - "inlineContent": [ - { - "type": "text", - "text": "Step 3:" - } - ] - }, - { - "type": "text", - "text": "" - }, - { - "text": " ", - "type": "text" - }, - { - "type": "text", - "text": "Load the player using the Playback SDK and handle any playback errors." - } - ] - } - ], - "type": "step", - "media": null, - "code": "Errors.swift", - "runtimePreview": null, - "caption": [ - { - "type": "paragraph", - "inlineContent": [ - { - "type": "text", - "text": "In this step described enum for error handling. " - }, - { - "type": "text", - "text": "Above is the error enum returned by the SDK, in this the apiError also return the reason code and message for the API error. " - }, - { - "type": "text", - "text": "The playback API is returning the reason code in the response , refer " - }, - { - "overridingTitle": "Get Video Playback Data | Playback", - "type": "reference", - "identifier": "playback_link", - "isActive": true - } - ] - } - ] - } - ], - "anchor": "PlayBack-SDK", - "contentSection": [ - { - "content": [ - { - "inlineContent": [ - { - "type": "strong", - "inlineContent": [ - { - "text": "Explore how to use StreamAMG Playback SDK.", - "type": "text" - } - ] - } - ], - "type": "paragraph" - } - ], - "kind": "fullWidth" - } - ] - } - ], - "kind": "tasks" - } - ], - "hierarchy": { - "reference": "doc://PlaybackSDK/tutorials/Table-Of-Contents", - "modules": [ - { - "reference": "doc://PlaybackSDK/tutorials/Table-Of-Contents/Getting-Started", - "projects": [ - { - "reference": "doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted", - "sections": [ - { - "kind": "task", - "reference": "doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted#PlayBack-SDK" - } - ] - } - ] - } - ], - "paths": [ - [ - "doc://PlaybackSDK/tutorials/Table-Of-Contents", - "doc://PlaybackSDK/tutorials/Table-Of-Contents/$volume", - "doc://PlaybackSDK/tutorials/Table-Of-Contents/Getting-Started" - ] - ] - }, - "kind": "project", - "metadata": { - "title": "Playback SDK Overview", - "category": "PlaybackSDK Tutorial", - "categoryPathComponent": "Table-Of-Contents", - "role": "project" - }, - "schemaVersion": { - "major": 0, - "minor": 3, - "patch": 0 - }, - "variants": [ - { - "traits": [ - { - "interfaceLanguage": "swift" - } - ], - "paths": [ - "/tutorials/playbacksdk/getstarted" - ] - } - ], - "identifier": { - "interfaceLanguage": "swift", - "url": "doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted" - }, - "references": { - "PlayerTestView.swift": { - "identifier": "PlayerTestView.swift", - "content": [ - "//", - "// LoadPlayerViewTutorial.swift", - "//", - "//", - "// Created by Franco Driansetti on 27/02/2024.", - "//", - "", - "import SwiftUI", - "import PlaybackSDK", - "", - "struct PlayerTestView: View {", - " ", - " private let entryID = \"ENTRY_ID\"", - " private let authorizationToken = \"JWT_TOKEN\"", - " ", - " var body: some View {", - " VStack {", - " // Load player with the playback SDK", - " PlayBackSDKManager.shared.loadPlayer(entryID: entryID, authorizationToken: authorizationToken) { error in", - " handlePlaybackError(error)", - " }", - " .onDisappear {", - " // Remove the player here", - " }", - " Spacer()", - " }", - " .padding()", - " }", - " ", - " private func handlePlaybackError(_ error: PlaybackError) {", - " switch error {", - " case .apiError(let statusCode, let errorMessage, let reason):", - " print(\"\\(errorMessage) Status Code \\(statusCode)\")", - " errorMessage = \"\\(errorMessage) Status Code \\(statusCode) Reason \\(reason)\"", - " default:", - " print(\"Error loading HLS stream in PlaybackUIView: \\(error.localizedDescription)\")", - " errorMessage = \"Error code and errorrMessage not found: \\(error.localizedDescription)\"", - " }", - " }", - " ", - "}" - ], - "syntax": "swift", - "fileType": "swift", - "highlights": [], - "fileName": "PlayerTestView.swift", - "type": "file" - }, - "Errors.swift": { - "identifier": "Errors.swift", - "highlights": [], - "fileType": "swift", - "type": "file", - "syntax": "swift", - "fileName": "Errors.swift", - "content": [ - "", - "public enum PlayBackAPIError: Error {", - "", - " case invalidResponsePlaybackData", - "", - " case invalidPlaybackDataURL", - "", - " case invalidPlayerInformationURL", - "", - " case initializationError", - "", - " case loadHLSStreamError", - "", - " case networkError(Error)", - "", - " case apiError(statusCode: Int, message: String)", - "", - "}" - ] - }, - "PlayBackDemoApp.swift": { - "identifier": "PlayBackDemoApp.swift", - "highlights": [], - "fileType": "swift", - "type": "file", - "syntax": "swift", - "fileName": "PlayBackDemoApp.swift", - "content": [ - "//", - "// InitializeSdkExample.swift", - "//", - "//", - "// Created by Franco Driansetti on 27/02/2024.", - "//", - "", - "import SwiftUI", - "import PlaybackSDK", - "", - "@main", - "struct PlayBackDemoApp: App {", - " ", - " let sdkManager = PlayBackSDKManager()", - " let apiKey = \"API_KEY\"", - " var body: some Scene {", - " WindowGroup {", - " HomeView()", - " }", - " }", - " ", - " init() {", - " // Initialize the Playback SDK with the provided API key and base URL", - " PlayBackSDKManager.shared.initialize(apiKey: apiKey) { result in", - " switch result {", - " case .success(let license):", - " // Obtained license upon successful initialization", - " print(\"SDK initialized with license: \\(license)\")", - " ", - " // Register the video player plugin", - " let bitmovinPlugin = BitmovinPlayerPlugin()", - " VideoPlayerPluginManager.shared.registerPlugin(bitmovinPlugin)", - " ", - " case .failure(let error):", - " // Print an error message and set initializationError flag upon initialization failure", - " print(\"SDK initialization failed with error: \\(error)\")", - " ", - " }", - " }", - " }", - "}" - ] - }, - "doc://PlaybackSDK/tutorials/Table-Of-Contents/Getting-Started": { - "title": "Getting Started", - "identifier": "doc://PlaybackSDK/tutorials/Table-Of-Contents/Getting-Started", - "role": "article", - "url": "/tutorials/table-of-contents/getting-started", - "abstract": [], - "kind": "article", - "type": "topic" - }, - "doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted": { - "title": "Playback SDK Overview", - "abstract": [ - { - "text": "Playback SDK simplifies integrating video playback functionalities into OTT applications. It provides a unified interface for interacting with video APIs and managing playback logic.", - "type": "text" - } - ], - "identifier": "doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted", - "url": "/tutorials/playbacksdk/getstarted", - "kind": "project", - "role": "project", - "estimatedTime": "30min", - "type": "topic" - }, - "doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted#PlayBack-SDK": { - "title": "Playback SDK", - "role": "pseudoSymbol", - "type": "section", - "url": "/tutorials/playbacksdk/getstarted#PlayBack-SDK", - "kind": "section", - "identifier": "doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted#PlayBack-SDK", - "abstract": [ - { - "text": "Playback SDK simplifies integrating video playback functionalities into OTT applications. It provides a unified interface for interacting with video APIs and managing playback logic.", - "type": "text" - } - ] - }, - "playback_link": { - "title": "Get Video Playback Data | Playback", - "role": "overview", - "type": "topic", - "role": "overview", - "url": "https://streamamg.stoplight.io/docs/playback-documentation-portal/ec642e6dcbb13-get-video-playback-data", - "kind": "section", - "identifier": "Get Video Playback Data | Playback ", - "abstract": [ - { - "text": "Get Video Playback Data | Playback", - "type": "text" - } - ] - }, - "doc://PlaybackSDK/tutorials/Table-Of-Contents": { - "identifier": "doc://PlaybackSDK/tutorials/Table-Of-Contents", - "kind": "overview", - "role": "overview", - "abstract": [ - { - "text": "Welcome to the PlaybackSDK tutorial! In this tutorial, you will learn how to integrate and use the PlaybackSDK in your iOS applications.", - "type": "text" - } - ], - "url": "/tutorials/table-of-contents", - "title": "Introduction to PlaybackSDK", - "type": "topic" - } - } - } \ No newline at end of file +{"kind":"project","hierarchy":{"modules":[{"reference":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents\/Getting-Started","projects":[{"sections":[{"kind":"task","reference":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted#Playback-SDK"}],"reference":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted"}]}],"reference":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents","paths":[["doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents","doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents\/$volume","doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents\/Getting-Started"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"title":"Playback SDK Overview","role":"project","category":"PlaybackSDK Tutorial","categoryPathComponent":"Table-Of-Contents"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/tutorials\/playbacksdk\/getstarted"]}],"sections":[{"content":[{"inlineContent":[{"type":"text","text":"Playback SDK simplifies integrating video playback functionalities into OTT applications. It provides a unified interface for interacting with video APIs and managing playback logic."}],"type":"paragraph"},{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Key Features:"}]}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Abstraction:"}]},{"type":"text","text":" Hides the complexities of underlying video APIs, allowing you to focus on the core playback experience."}]}]},{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Flexibility:"}]},{"type":"text","text":" Supports different video providers and allows the creation of custom playback plugins for extended functionalities."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Error Handling:"}]},{"type":"text","text":" Provides mechanisms to handle potential issues during playback and notify your application."}]}]}]}],"title":"Playback SDK Overview","chapter":"Getting Started","estimatedTimeInMinutes":30,"kind":"hero"},{"kind":"tasks","tasks":[{"title":"Playback SDK","contentSection":[{"kind":"fullWidth","content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"text":"Explore how to use StreamAMG Playback SDK.","type":"text"}],"type":"strong"}]}]}],"stepsSection":[{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"Step 1:","type":"text"}]},{"type":"text","text":" Initialize the Playback SDK by providing your API key and register the default player plugin."},{"text":" ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Make sure this step is done when the app starts."}]}]}],"media":null,"caption":[],"type":"step","code":"PlayBackDemoApp.swift","runtimePreview":null},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"Step 2:","type":"text"}]},{"type":"text","text":""},{"text":" ","type":"text"},{"type":"text","text":"Load the player using the Playback SDK and handle any playback errors."}]}],"media":null,"code":"PlayerTestView.swift","caption":[{"type":"paragraph","inlineContent":[{"text":"In this step, the code utilizes the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"loadPlayer"}]},{"type":"text","text":" function provided by the Playback SDK to initialize and load the video player. The function takes the entry ID and authorization token as parameters. Additionally, it includes a closure to handle any potential playback errors that may occur during the loading process."},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"handlePlaybackError"}]},{"text":" function is called within the closure to handle the playback errors. It switches on the type of error received and provides appropriate error handling based on the type of error encountered.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"The code also includes a placeholder comment to indicate where the removal of the player could be implemented in the "},{"type":"strong","inlineContent":[{"text":"onDisappear","type":"text"}]},{"text":" modifier.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"If you want to allow users to access free content or if you’re implementing a guest mode, you can pass an empty string or "},{"inlineContent":[{"type":"text","text":"nil"}],"type":"strong"},{"type":"text","text":" value as the "},{"inlineContent":[{"type":"text","text":"authorizationToken"}],"type":"strong"},{"type":"text","text":" when calling the "},{"type":"strong","inlineContent":[{"type":"text","text":"loadPlayer"}]},{"text":" function. This will bypass the need for authentication, enabling unrestricted access to the specified content.","type":"text"}]}],"type":"step","runtimePreview":null},{"caption":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This step describes enum for error handling. Above is the error enum returned by the SDK, where the apiError also has the reason code and message for the API error. The playback API is returning the reason code in the response. For the list of the error codes and reasons, please refer to "},{"identifier":"https:\/\/streamamg.stoplight.io\/docs\/playback-documentation-portal\/ec642e6dcbb13-get-video-playback-data","isActive":true,"type":"reference"}]}],"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"text":"Step 3:","type":"text"}],"type":"strong"},{"text":" ","type":"text"},{"text":"Handle the playback errors from Playback SDK.","type":"text"}]}],"type":"step","code":"PlayBackAPIError.swift","media":null,"runtimePreview":null}],"anchor":"Playback-SDK"}]}],"references":{"doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted":{"role":"project","identifier":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted","title":"Playback SDK Overview","type":"topic","kind":"project","estimatedTime":"30min","url":"\/tutorials\/playbacksdk\/getstarted","abstract":[{"type":"text","text":"Playback SDK simplifies integrating video playback functionalities into OTT applications. It provides a unified interface for interacting with video APIs and managing playback logic."}]},"PlayBackAPIError.swift":{"highlights":[],"type":"file","identifier":"PlayBackAPIError.swift","fileName":"PlayBackAPIError.swift","fileType":"swift","syntax":"swift","content":["import Foundation","","public enum PlayBackAPIError: Error {",""," case invalidResponsePlaybackData",""," case invalidPlaybackDataURL",""," case invalidPlayerInformationURL",""," case initializationError",""," case loadHLSStreamError",""," case networkError(Error)",""," case apiError(statusCode: Int, message: String)","}"]},"doc://PlaybackSDK/tutorials/Table-Of-Contents":{"role":"overview","identifier":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents","title":"Introduction to PlaybackSDK","type":"topic","kind":"overview","url":"\/tutorials\/table-of-contents","abstract":[{"type":"text","text":"Welcome to the PlaybackSDK tutorial! In this tutorial, you will learn how to integrate and use the PlaybackSDK in your iOS applications."}]},"doc://PlaybackSDK/tutorials/Table-Of-Contents/Getting-Started":{"kind":"article","identifier":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents\/Getting-Started","abstract":[],"title":"Getting Started","type":"topic","role":"article","url":"\/tutorials\/table-of-contents\/getting-started"},"PlayBackDemoApp.swift":{"fileName":"PlayBackDemoApp.swift","highlights":[],"type":"file","fileType":"swift","syntax":"swift","identifier":"PlayBackDemoApp.swift","content":["import SwiftUI","import PlaybackSDK","","@main","struct PlayBackDemoApp: App {"," "," let sdkManager = PlayBackSDKManager()"," let apiKey = \"API_KEY\""," var body: some Scene {"," WindowGroup {"," HomeView()"," }"," }"," "," init() {"," \/\/ Initialize the Playback SDK with the provided API key and base URL"," PlayBackSDKManager.shared.initialize(apiKey: apiKey) { result in"," switch result {"," case .success(let license):"," \/\/ Obtained license upon successful initialization"," print(\"SDK initialized with license: \\(license)\")"," "," \/\/ Register the video player plugin"," let bitmovinPlugin = BitmovinPlayerPlugin()"," VideoPlayerPluginManager.shared.registerPlugin(bitmovinPlugin)"," "," case .failure(let error):"," \/\/ Print an error message and set initializationError flag upon initialization failure"," print(\"SDK initialization failed with error: \\(error)\")"," "," }"," }"," }","}"]},"PlayerTestView.swift":{"fileType":"swift","syntax":"swift","fileName":"PlayerTestView.swift","identifier":"PlayerTestView.swift","type":"file","highlights":[],"content":["import SwiftUI","import PlaybackSDK","","struct PlayerTestView: View {"," "," private let entryID = \"ENTRY_ID\""," private let authorizationToken = \"JWT_TOKEN\""," "," var body: some View {"," VStack {"," \/\/ Load player with the playback SDK"," PlayBackSDKManager.shared.loadPlayer(entryID: entryID, authorizationToken: authorizationToken) { error in"," handlePlaybackError(error)"," }"," .onDisappear {"," \/\/ Remove the player here"," }"," Spacer()"," }"," .padding()"," }"," "," private func handlePlaybackError(_ error: PlaybackError) {"," switch error {"," case .apiError(let statusCode, let errorMessage, let reason):"," print(\"\\(errorMessage) Status Code \\(statusCode)\")"," errorMessage = \"\\(errorMessage) Status Code \\(statusCode) Reason \\(reason)\""," default:"," print(\"Error loading HLS stream in PlaybackUIView: \\(error.localizedDescription)\")"," errorMessage = \"Error code and errorrMessage not found: \\(error.localizedDescription)\""," }"," }"," ","}"]},"doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted#Playback-SDK":{"role":"pseudoSymbol","identifier":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted#Playback-SDK","type":"section","title":"Playback SDK","kind":"section","abstract":[{"text":"Playback SDK simplifies integrating video playback functionalities into OTT applications. It provides a unified interface for interacting with video APIs and managing playback logic.","type":"text"}],"url":"\/tutorials\/playbacksdk\/getstarted#Playback-SDK"},"https://streamamg.stoplight.io/docs/playback-documentation-portal/ec642e6dcbb13-get-video-playback-data":{"type":"link","url":"https:\/\/streamamg.stoplight.io\/docs\/playback-documentation-portal\/ec642e6dcbb13-get-video-playback-data","title":"Get Video Playback Data | Playback","titleInlineContent":[{"text":"Get Video Playback Data | Playback","type":"text"}],"identifier":"https:\/\/streamamg.stoplight.io\/docs\/playback-documentation-portal\/ec642e6dcbb13-get-video-playback-data"}}} \ No newline at end of file diff --git a/docs/data/tutorials/table-of-contents.json b/docs/data/tutorials/table-of-contents.json index f653b1b..6f48e05 100644 --- a/docs/data/tutorials/table-of-contents.json +++ b/docs/data/tutorials/table-of-contents.json @@ -1 +1 @@ -{"metadata":{"category":"PlaybackSDK Tutorial","title":"Introduction to PlaybackSDK","estimatedTime":"30min","categoryPathComponent":"Table-Of-Contents","role":"overview"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Welcome to the PlaybackSDK tutorial! In this tutorial, you will learn how to integrate and use the PlaybackSDK in your iOS applications."}]}],"action":{"identifier":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted","type":"reference","isActive":true,"overridingTitle":"Get started","overridingTitleInlineContent":[{"text":"Get started","type":"text"}]},"kind":"hero","title":"Introduction to PlaybackSDK"},{"name":null,"kind":"volume","chapters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"In this chapter, we’ll start by setting up the PlaybackSDK from the initialisation to load the Playback Player Plugin.","type":"text"}]}],"name":"Getting Started","image":"ios-marketing.png","tutorials":["doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted"]}],"image":null,"content":[]},{"tiles":[{"identifier":"documentation","title":"Documentation","content":[{"inlineContent":[{"text":"Browse and search the PlaybackSDK documentation.","type":"text"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"reference","identifier":"https:\/\/github.com\/StreamAMG\/playback-sdk-ios\/tree\/main","isActive":true}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"identifier":"https:\/\/streamamg.stoplight.io","type":"reference"}]}]}]}]}],"content":[{"inlineContent":[{"type":"text","text":"Explore more resources for learning about PlaybackSDK."}],"type":"paragraph"}],"kind":"resources"}],"hierarchy":{"reference":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents","paths":[]},"kind":"overview","variants":[{"paths":["\/tutorials\/table-of-contents"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"ios-marketing.png":{"variants":[{"url":"\/images\/ios-marketing.png","traits":["1x","light"]}],"identifier":"ios-marketing.png","type":"image","alt":"Getting Started with PlaybackSDK"},"https://streamamg.stoplight.io":{"identifier":"https:\/\/streamamg.stoplight.io","title":"Stoplight Playback API","titleInlineContent":[{"text":"Stoplight Playback API","type":"text"}],"url":"https:\/\/streamamg.stoplight.io","type":"link"},"doc://PlaybackSDK/tutorials/Table-Of-Contents":{"identifier":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents","kind":"overview","role":"overview","abstract":[{"text":"Welcome to the PlaybackSDK tutorial! In this tutorial, you will learn how to integrate and use the PlaybackSDK in your iOS applications.","type":"text"}],"url":"\/tutorials\/table-of-contents","title":"Introduction to PlaybackSDK","type":"topic"},"doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted":{"title":"Playback SDK Overview","abstract":[{"text":"Playback SDK simplifies integrating video playback functionalities into OTT applications. It provides a unified interface for interacting with video APIs and managing playback logic.","type":"text"}],"identifier":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted","url":"\/tutorials\/playbacksdk\/getstarted","kind":"project","role":"project","estimatedTime":"30min","type":"topic"},"https://github.com/StreamAMG/playback-sdk-ios/tree/main":{"identifier":"https:\/\/github.com\/StreamAMG\/playback-sdk-ios\/tree\/main","title":"GitHub Repository","url":"https:\/\/github.com\/StreamAMG\/playback-sdk-ios\/tree\/main","titleInlineContent":[{"text":"GitHub Repository","type":"text"}],"type":"link"}}} \ No newline at end of file +{"sections":[{"title":"Introduction to PlaybackSDK","kind":"hero","action":{"isActive":true,"overridingTitle":"Get started","identifier":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted","overridingTitleInlineContent":[{"type":"text","text":"Get started"}],"type":"reference"},"content":[{"inlineContent":[{"text":"Welcome to the PlaybackSDK tutorial! In this tutorial, you will learn how to integrate and use the PlaybackSDK in your iOS applications.","type":"text"}],"type":"paragraph"}]},{"name":null,"kind":"volume","chapters":[{"name":"Getting Started","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"In this chapter, we’ll start by setting up the PlaybackSDK from the initialisation to load the PlayBack Player Plugin."}]}],"tutorials":["doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted"],"image":"ios-marketing.png"}],"image":null,"content":[]},{"tiles":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Browse and search the PlaybackSDK documentation."}]},{"items":[{"content":[{"inlineContent":[{"isActive":true,"identifier":"https:\/\/github.com\/StreamAMG\/playback-sdk-ios\/tree\/main","type":"reference"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"identifier":"https:\/\/streamamg.stoplight.io","type":"reference"}]}]}],"type":"unorderedList"}],"identifier":"documentation","title":"Documentation"}],"content":[{"inlineContent":[{"text":"Explore more resources for learning about PlaybackSDK.","type":"text"}],"type":"paragraph"}],"kind":"resources"}],"kind":"overview","schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"role":"overview","category":"PlaybackSDK Tutorial","categoryPathComponent":"Table-Of-Contents","estimatedTime":"30min","title":"Introduction to PlaybackSDK"},"identifier":{"url":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents","interfaceLanguage":"swift"},"hierarchy":{"paths":[],"reference":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents"},"variants":[{"paths":["\/tutorials\/table-of-contents"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://PlaybackSDK/tutorials/Table-Of-Contents":{"role":"overview","identifier":"doc:\/\/PlaybackSDK\/tutorials\/Table-Of-Contents","title":"Introduction to PlaybackSDK","type":"topic","kind":"overview","url":"\/tutorials\/table-of-contents","abstract":[{"type":"text","text":"Welcome to the PlaybackSDK tutorial! In this tutorial, you will learn how to integrate and use the PlaybackSDK in your iOS applications."}]},"ios-marketing.png":{"variants":[{"traits":["1x","light"],"url":"\/images\/ios-marketing.png"}],"alt":"Getting Started with PlaybackSDK","identifier":"ios-marketing.png","type":"image"},"doc://PlaybackSDK/tutorials/PlaybackSDK/GetStarted":{"role":"project","identifier":"doc:\/\/PlaybackSDK\/tutorials\/PlaybackSDK\/GetStarted","title":"Playback SDK Overview","type":"topic","kind":"project","estimatedTime":"30min","url":"\/tutorials\/playbacksdk\/getstarted","abstract":[{"type":"text","text":"Playback SDK simplifies integrating video playback functionalities into OTT applications. It provides a unified interface for interacting with video APIs and managing playback logic."}]},"https://streamamg.stoplight.io":{"titleInlineContent":[{"type":"text","text":"Stoplight PlayBack API"}],"url":"https:\/\/streamamg.stoplight.io","title":"Stoplight PlayBack API","identifier":"https:\/\/streamamg.stoplight.io","type":"link"},"https://github.com/StreamAMG/playback-sdk-ios/tree/main":{"title":"GitHub Repository","identifier":"https:\/\/github.com\/StreamAMG\/playback-sdk-ios\/tree\/main","type":"link","titleInlineContent":[{"type":"text","text":"GitHub Repository"}],"url":"https:\/\/github.com\/StreamAMG\/playback-sdk-ios\/tree\/main"}}} \ No newline at end of file diff --git a/docs/documentation/playbacksdk/index.html b/docs/documentation/playbacksdk/index.html index c25d820..d5df4d7 100644 --- a/docs/documentation/playbacksdk/index.html +++ b/docs/documentation/playbacksdk/index.html @@ -1 +1 @@ -Documentation
\ No newline at end of file +Documentation
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index c25d820..d5df4d7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1 +1 @@ -Documentation
\ No newline at end of file +Documentation
\ No newline at end of file diff --git a/docs/metadata.json b/docs/metadata.json index 2820538..3988104 100644 --- a/docs/metadata.json +++ b/docs/metadata.json @@ -1 +1 @@ -{"bundleIdentifier":"PlaybackSDK","bundleDisplayName":"PlaybackSDK","schemaVersion":{"major":0,"patch":0,"minor":1}} \ No newline at end of file +{"bundleIdentifier":"PlaybackSDK","bundleDisplayName":"PlaybackSDK","schemaVersion":{"major":0,"minor":1,"patch":0}} \ No newline at end of file diff --git a/docs/theme-settings.json b/docs/theme-settings.json deleted file mode 100644 index 0fd159a..0000000 --- a/docs/theme-settings.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "theme": { - "color": { - "documentation-intro-fill": "rebeccapurple" - } - } -} diff --git a/docs/tutorials/playbacksdk/getstarted/index.html b/docs/tutorials/playbacksdk/getstarted/index.html index c25d820..d5df4d7 100644 --- a/docs/tutorials/playbacksdk/getstarted/index.html +++ b/docs/tutorials/playbacksdk/getstarted/index.html @@ -1 +1 @@ -Documentation
\ No newline at end of file +Documentation
\ No newline at end of file diff --git a/docs/tutorials/table-of-contents/index.html b/docs/tutorials/table-of-contents/index.html index c25d820..d5df4d7 100644 --- a/docs/tutorials/table-of-contents/index.html +++ b/docs/tutorials/table-of-contents/index.html @@ -1 +1 @@ -Documentation
\ No newline at end of file +Documentation
\ No newline at end of file