diff --git a/docs/DEVELOPER/certification-overview/cert-tests/channel-behavior-analysis-tool.md b/docs/DEVELOPER/certification-overview/cert-tests/channel-behavior-analysis-tool.md index 6f35fb66..4fd04530 100644 --- a/docs/DEVELOPER/certification-overview/cert-tests/channel-behavior-analysis-tool.md +++ b/docs/DEVELOPER/certification-overview/cert-tests/channel-behavior-analysis-tool.md @@ -12,6 +12,6 @@ next: --- -> Subscription (SVOD), ad-supported (AVOD), and free apps must pass automated certification testing in order to published to the Streaming Store. Apps cannot be submitted for publishing without passing automated certification testing. +> Subscription (SVOD), ad-supported (AVOD), and free apps must pass automated certification testing in order to publish to the Streaming Store. Apps cannot be submitted for publishing without passing automated certification testing. The [App Behavior Analysis tool](doc:channel-publishing-guide), which is a part of the app builder flow in the Developer Dashboard, enables developers to run self-serve automated certification tests on their apps. The tool verifies whether apps meet the following [performance](doc:certification) and [deep linking](doc:certification) certification requirements: diff --git a/docs/DEVELOPER/certification-overview/cert-tests/static-analysis-tool-1.md b/docs/DEVELOPER/certification-overview/cert-tests/static-analysis-tool-1.md index 42fdc503..4e29a57e 100644 --- a/docs/DEVELOPER/certification-overview/cert-tests/static-analysis-tool-1.md +++ b/docs/DEVELOPER/certification-overview/cert-tests/static-analysis-tool-1.md @@ -12,6 +12,6 @@ next: --- -> Apps must pass Static Analysis testing in order to published to the Streaming Store. Apps cannot be submitted for publishing without passing static analysis testing. +> Apps must pass Static Analysis testing in order to publish to the Streaming Store. Apps cannot be submitted for publishing without passing static analysis testing. The [Static Analysis tool](doc:static-analysis-tool), which is a part of the app builder flow in the Developer Dashboard, enables developers to verify that their app's BrightScript source code complies with Roku certification criteria. The tool checks whether the app's code contains any of the following certification-related errors: diff --git a/docs/DEVELOPER/core-concepts/index.md b/docs/DEVELOPER/core-concepts/index.md index 23a1bf89..20196364 100644 --- a/docs/DEVELOPER/core-concepts/index.md +++ b/docs/DEVELOPER/core-concepts/index.md @@ -25,6 +25,6 @@ In addition, the SceneGraph XML programming framework includes a new capability You can learn more about the SceneGraph development framework by watching the [Core concepts](doc:debugging) video lesson in Roku's [SceneGraph: Build an App online video course](https://developer.roku.com/videos/courses/rsg/overview). -This lesson reviews core concepts for Roku app app development. It explains the basic design principles and key concepts for developing on the Roku platform, outlines the contents and structure of Roku apps, and compares the programming languages used to build Roku apps: SceneGraph and BrightScript. It highlights the different types of SceneGraph components you can use to build the app UI. +This lesson reviews core concepts for Roku app development. It explains the basic design principles and key concepts for developing on the Roku platform, outlines the contents and structure of Roku apps, and compares the programming languages used to build Roku apps: SceneGraph and BrightScript. It highlights the different types of SceneGraph components you can use to build the app UI. The lesson continues by providing a high-level overview of several key topics such as threading, event handling, and data scoping. It concludes by explaining the importance of factoring graceful degradation in the app design. diff --git a/docs/DEVELOPER/dev-tools/resource-monitor/rrm-data-collection-mode.md b/docs/DEVELOPER/dev-tools/resource-monitor/rrm-data-collection-mode.md index df5b8ca8..79b22aef 100644 --- a/docs/DEVELOPER/dev-tools/resource-monitor/rrm-data-collection-mode.md +++ b/docs/DEVELOPER/dev-tools/resource-monitor/rrm-data-collection-mode.md @@ -1,5 +1,5 @@ --- -title: Using Roku Resouce Monitor in Data Collection Mode +title: Using Roku Resource Monitor in Data Collection Mode excerpt: '' deprecated: false hidden: false @@ -40,7 +40,7 @@ roku-resource-monitor.bat --help The following table lists the options you can enter: -
OptionDescriptionRequired/Optional
--helpDisplays a help message and exitOptional
--headlessRuns RRM in Data Collection Mode (CLI mode without user interface)Requried
--device-ip \Enter the IP address of the test Roku device (for example, 192.168.0.0)Required
--channel-id \Enter the channel ID of the app to be monitored.Required
--output-file \Enter the file or directory to output the collected data (for example, /home/Downloads)Optional
--panels \Enter a comma-separated list of the metrics to be collected:
  • memory
  • graphics_memory
  • cpu
  • scenegraph_nodes
  • frame_rate
  • registry_usage
  • sgrendezvous
  • object_byte_count

MacOS Example (with options)

roku-resource-monitor --headless --device-ip=192.168.0.0 --channel-id=1 --output-file=/home/Downloads --panels=cpu,memory --polling-interval=1
Optional
--polling-interval \Set how frequently data is collected (by default 1-second intervals are used).Optional
+
OptionDescriptionRequired/Optional
--helpDisplays a help message and exitOptional
--headlessRuns RRM in Data Collection Mode (CLI mode without user interface)Required
--device-ip \Enter the IP address of the test Roku device (for example, 192.168.0.0)Required
--channel-id \Enter the channel ID of the app to be monitored.Required
--output-file \Enter the file or directory to output the collected data (for example, /home/Downloads)Optional
--panels \Enter a comma-separated list of the metrics to be collected:
  • memory
  • graphics_memory
  • cpu
  • scenegraph_nodes
  • frame_rate
  • registry_usage
  • sgrendezvous
  • object_byte_count

MacOS Example (with options)

roku-resource-monitor --headless --device-ip=192.168.0.0 --channel-id=1 --output-file=/home/Downloads --panels=cpu,memory --polling-interval=1
Optional
--polling-interval \Set how frequently data is collected (by default 1-second intervals are used).Optional
## Using the Docker CLI to run data collection mode diff --git a/docs/DEVELOPER/dev-tools/sgdex.md b/docs/DEVELOPER/dev-tools/sgdex.md index 89d049c6..d3f809fa 100644 --- a/docs/DEVELOPER/dev-tools/sgdex.md +++ b/docs/DEVELOPER/dev-tools/sgdex.md @@ -13,5 +13,3 @@ next: Scene Graph Developer Extensions (SGDEX) is a collection of developer sample code that demonstrates how a developer can use pre-built, reusable Roku Scene Graph (RSG) components to enable rapid development of apps that follow a consistent UX paradigm. For more information on using SGDEX, click [here](https://github.com/rokudev/SceneGraphDeveloperExtensions#overview) - -[https://github.com/rokudev/SceneGraphDeveloperExtensions#overview]() diff --git a/docs/DEVELOPER/discovery/continue-watching-cloud.md b/docs/DEVELOPER/discovery/continue-watching-cloud.md index 9928ffb8..d0a9fb8b 100644 --- a/docs/DEVELOPER/discovery/continue-watching-cloud.md +++ b/docs/DEVELOPER/discovery/continue-watching-cloud.md @@ -11,7 +11,7 @@ Continue Watching is a content category row within the **What to Watch** home sc roku815px - continue watching row -> The Continue Watching feature is available on all Roku devices running [Roku OS 11.0](doc:release-notes#roku-os-110) or higher in the United States, Canda, United Kingdom, Germany, Mexico, Chile, Argentina, and Colombia. +> The Continue Watching feature is available on all Roku devices running [Roku OS 11.0](doc:release-notes#roku-os-110) or higher in the United States, Canada, United Kingdom, Germany, Mexico, Chile, Argentina, and Colombia. > > Apps in the U.S. Streaming Store that have streamed more than an average of 5 million hours per month over the last three months must participate in Roku’s Continue Watching program to pass [certification](doc:certification#4-app-operation). This requirement also applies to new apps projected to reach the specified streaming hours threshold shortly after launch. TVOD, live linear, and made-for-kids apps are excluded from this requirement. > diff --git a/docs/DEVELOPER/getting-started/first-steps.md b/docs/DEVELOPER/getting-started/first-steps.md index 4741dbea..1ccac38d 100644 --- a/docs/DEVELOPER/getting-started/first-steps.md +++ b/docs/DEVELOPER/getting-started/first-steps.md @@ -26,4 +26,4 @@ To get started building a Roku app, do the following: -- **[Activate developer mode on your device](doc:developer-setup)**. This enables you run sample apps on your device to help you learn Roku development and being running and testing your own apps. +- **[Activate developer mode on your device](doc:developer-setup)**. This enables you run sample apps on your device to help you learn Roku development and begin running and testing your own apps. diff --git a/docs/DEVELOPER/roku-pay/_order.yaml b/docs/DEVELOPER/roku-pay/_order.yaml index ef411afe..07de8a96 100644 --- a/docs/DEVELOPER/roku-pay/_order.yaml +++ b/docs/DEVELOPER/roku-pay/_order.yaml @@ -4,5 +4,5 @@ - testing - roku-pay-requirements - roku-pay-best-practices -- signup_best-practices -- signin_best-practices \ No newline at end of file +- signup-best-practices +- signin-best-practices \ No newline at end of file diff --git a/docs/DEVELOPER/roku-pay/quickstart/product-catalog.md b/docs/DEVELOPER/roku-pay/quickstart/product-catalog.md index 0318a6bc..e0aa071f 100644 --- a/docs/DEVELOPER/roku-pay/quickstart/product-catalog.md +++ b/docs/DEVELOPER/roku-pay/quickstart/product-catalog.md @@ -496,7 +496,7 @@ To delete a product group, click the garbage can icon on the right side of the p ## Testing in-app product purchases -To test in-app product purchases on a betan app, the app must: +To test in-app product purchases on a beta app, the app must: * be configured with subscription and/or one-time purchase monetization methods. * be enabled for billing testing. diff --git a/docs/REFERENCES/brightscript/components/roaudioresource.md b/docs/REFERENCES/brightscript/components/roaudioresource.md index a249a25f..efd3061b 100644 --- a/docs/REFERENCES/brightscript/components/roaudioresource.md +++ b/docs/REFERENCES/brightscript/components/roaudioresource.md @@ -12,7 +12,7 @@ next: --- -The roAudioResouce allows .wav files to be cached to memory and quickly played at any time. roAudioResource is intended to support short audio clips which need to be played with very little latency. The system caches the entire wav file in memory so that playback can begin very quickly. +The roAudioResource allows .wav files to be cached to memory and quickly played at any time. roAudioResource is intended to support short audio clips which need to be played with very little latency. The system caches the entire wav file in memory so that playback can begin very quickly. On Roku "Classic" models, roAudioResource does not support mixing of sounds. So when you play a sound effect, any background music is paused while the sound effect plays and then resumes after the sound effect ends. On later models, sound effects are mixed with background music. See the [Hardware specifications document](doc:hardware) for a list of Current and Classic models. diff --git a/docs/REFERENCES/brightscript/interfaces/ifaudioresource.md b/docs/REFERENCES/brightscript/interfaces/ifaudioresource.md index 51a56f39..877557c5 100644 --- a/docs/REFERENCES/brightscript/interfaces/ifaudioresource.md +++ b/docs/REFERENCES/brightscript/interfaces/ifaudioresource.md @@ -16,7 +16,7 @@ next: | Name | Description | | --------------- | ----------------------------------------- | -| [roAudioResource](doc:roaudioresource) | The roAudioResouce allows .wav files to be cached to memory and quickly played at any time | +| [roAudioResource](doc:roaudioresource) | The roAudioResource allows .wav files to be cached to memory and quickly played at any time | ## Supported methods diff --git a/docs/THE ROKU CHANNEL/live-linear/ovp-linear-ingest-spec.md b/docs/THE ROKU CHANNEL/live-linear/ovp-linear-ingest-spec.md index 46b75a55..fa298619 100644 --- a/docs/THE ROKU CHANNEL/live-linear/ovp-linear-ingest-spec.md +++ b/docs/THE ROKU CHANNEL/live-linear/ovp-linear-ingest-spec.md @@ -710,7 +710,7 @@ Notes: * Please include the liveFeed as the first item in a feed. * Only a title or a **TMS** ExternalID is required for programs referenced in a schedule. We will reject anything that's not a **valid** ExternalID. -* When referencing an episode, the parent items must also be in included ([series](/docs/specs/direct-publisher-feed-specs/json-dp-spec.md#series) and [season](/docs/specs/direct-publisher-feed-specs/json-dp-spec.md#season) when applicable). These parent items must be **fully populated with required fields** as specified in the [Roku Direct Published feed specification](/docs/specs/direct-publisher-feed-specs/json-dp-spec.md) or the series item must contain a valid External **TMS** id. +* When referencing an episode, the parent items must also be in included ([series](/docs/specs/direct-publisher-feed-specs/json-dp-spec.md#series) and [season](/docs/specs/direct-publisher-feed-specs/json-dp-spec.md#season) when applicable). These parent items must be **fully populated with required fields** as specified in the [Roku Direct Publisher feed specification](/docs/specs/direct-publisher-feed-specs/json-dp-spec.md) or the series item must contain a valid External **TMS** id. ![roku400px - feedspecs-1](https://image.roku.com/ZHZscHItMTc2/feed-specs-1-v2.jpg) diff --git a/docs/THE ROKU CHANNEL/video-on-demand/_order.yaml b/docs/THE ROKU CHANNEL/video-on-demand/_order.yaml index aeb36bed..d2da636f 100644 --- a/docs/THE ROKU CHANNEL/video-on-demand/_order.yaml +++ b/docs/THE ROKU CHANNEL/video-on-demand/_order.yaml @@ -2,4 +2,3 @@ - roku-originals - delivery - title-avail-specifications -- recs diff --git a/docs/THE ROKU CHANNEL/video-on-demand/index.md b/docs/THE ROKU CHANNEL/video-on-demand/index.md index dcf7a058..b5f53a5d 100644 --- a/docs/THE ROKU CHANNEL/video-on-demand/index.md +++ b/docs/THE ROKU CHANNEL/video-on-demand/index.md @@ -63,4 +63,4 @@ Payments and revenue reports are sent out quarterly, 60 days post-quarter closin | Q3 | By November 30th | | Q4 | By February 28th | -Not that partners will not be paid until the aggregate sums due are equal to or exceed $100.00. Detailed payout terms are found in the Commercial Terms Exhibit of the [Roku Distribution Agreement](https://docs.roku.com/doc/developerdistribution/en-us). +Note that partners will not be paid until the aggregate sums due are equal to or exceed $100.00. Detailed payout terms are found in the Commercial Terms Exhibit of the [Roku Distribution Agreement](https://docs.roku.com/doc/developerdistribution/en-us). diff --git a/docs/VIDEOS/demos/index.md b/docs/VIDEOS/demos/index.md index 6229294c..e3fc6f24 100644 --- a/docs/VIDEOS/demos/index.md +++ b/docs/VIDEOS/demos/index.md @@ -24,11 +24,11 @@ This webinars and demos section includes the following videos: * [**Developer Summit 2024**](doc:summit-2024): Roku held its annual developer summit online on September 24–25, 2024. The summit opened with the keynote address, which included the traditional recap of the past year in streaming and key industry trends, new product and feature announcements, and a summary of new features recently added to the Roku Developer Dashboard. After the keynote, a series of panel discussions were held over two days that included: SceneGraph, Developer tools, community tools, voice AI gaming, test automation, and more. -* **[Enhanced Subscription Recovery Webinar](doc:enhanced-sub-recovery)**: This webinar, presented on July 15th, 2024, explained reviewed the Enhanced Subscription Recovery feature and explained how to implement, test, and enable it in your apps. +* **[Enhanced Subscription Recovery Webinar](doc:enhanced-sub-recovery)**: This webinar, presented on July 15th, 2024, reviewed the Enhanced Subscription Recovery feature and explained how to implement, test, and enable it in your apps. -* **[Roku Resoure Monitor Memory Management Webinar](doc:rrm-mem-mgmt)**: This webinar, presented on June 18th, 2024, explained how developers can build task nodes in their apps to efficiently use memory and CPU resources, manage the duration and number of rendezvouses, and implement observer functions, which run when tasks are completed. +* **[Roku Resource Monitor Memory Management Webinar](doc:rrm-mem-mgmt)**: This webinar, presented on June 18th, 2024, explained how developers can build task nodes in their apps to efficiently use memory and CPU resources, manage the duration and number of rendezvouses, and implement observer functions, which run when tasks are completed. -* **[Roku Resoure Monitor 3.0 Webinar](doc:rrm-3-0)**: In May 2024, Roku's Developer Platform team explained how developers can use the Roku Resource Monitor to identify memory and CPU consumption trends and patterns in their apps. This webinar highlights the latest features in the tool, including new graphs that track BrightScript object allocation patterns in apps. +* **[Roku Resource Monitor 3.0 Webinar](doc:rrm-3-0)**: In May 2024, Roku's Developer Platform team explained how developers can use the Roku Resource Monitor to identify memory and CPU consumption trends and patterns in their apps. This webinar highlights the latest features in the tool, including new graphs that track BrightScript object allocation patterns in apps. * **[Roku OS 13.0 Developer Features Webinar](doc:roku-os-13-0)**: In April 2024, Roku's Advanced Tech team reviewed the new SceneGraph and BrightScript APIs, media and content metadata enhancements, and developer tool updates included in [Roku OS 13.0](doc:release-notes#roku-os-130). @@ -48,7 +48,7 @@ This webinars and demos section includes the following videos: * **[Trickplay Thumbnail Webinar](doc:trickplay-webinar)**: In May 2022, Roku presented a webinar demonstrating how to integrate trickplay thumbnails in an app. Topics covered in this webinar included how trickplay thumbnails enhance the playback experience when rewinding, fast-forwarding, and seeking content; certification requirements for video content that is longer than 15 minutes; and available trickplay formats (HLS, DASH, and Roku’s BIF format). The webinar featured a demo showing how to generate, test, and implement trickplay thumbnails for HLS, DASH, and BIF formats. -* **[Developer Summit 2021](doc:summit-2021)**: Roku held its annual developer summit online on October 26–27, 2021. The summit started with a keynote address that recapped the past year in streaming and highlighted key industry trends for the upcoming year. The keynote then highlighted the opportunity for publishers to distribute their apps in Germany and recapped the latest Roku Voice features. The keynote also included a summary of the latest updates to self-serve certification and certification requirements. During the keynote address, Roku announced a number of new platform features, including Instant Resume, the new Search feed spec 2.0, and Developer Dashboard 2.0. Also announced was the release of the Independent Developer Kit (IDK) and betan app feature, and the sunsetting of non-certified apps. +* **[Developer Summit 2021](doc:summit-2021)**: Roku held its annual developer summit online on October 26–27, 2021. The summit started with a keynote address that recapped the past year in streaming and highlighted key industry trends for the upcoming year. The keynote then highlighted the opportunity for publishers to distribute their apps in Germany and recapped the latest Roku Voice features. The keynote also included a summary of the latest updates to self-serve certification and certification requirements. During the keynote address, Roku announced a number of new platform features, including Instant Resume, the new Search feed spec 2.0, and Developer Dashboard 2.0. Also announced was the release of the Independent Developer Kit (IDK) and beta app feature, and the sunsetting of non-certified apps. * **[Germany App Distribution Webinar](doc:germany-webinar)**: In September 2021, Roku presented a webinar explaining how to take advantage of Roku’s expansion into Germany by publishing apps to Roku's Germany Streaming Store. Topics covered in this webinar included: the importance of being in the German Streaming Store upon its launch and the opportunity offered to by the German market, updating your app in the Developer Dashboard, updating your Roku search feed, and localizing Roku Pay in-app products. diff --git a/docs/VIDEOS/demos/summit-2021.md b/docs/VIDEOS/demos/summit-2021.md index 99cc9ff5..277aa5aa 100644 --- a/docs/VIDEOS/demos/summit-2021.md +++ b/docs/VIDEOS/demos/summit-2021.md @@ -12,7 +12,7 @@ next: --- Roku held their annual developer summit online on October 26–27, 2021. The summit started with a keynote address that recapped the past year in streaming and highlighted key industry trends for the upcoming year. The keynote then highlighted the opportunity for publishers to [distribute their apps in Germany](https://partnersuccess.roku.com/hc/en-us/articles/1500006343601) and recapped the latest [Roku Voice features](doc:overview). The keynote also included a summary of the latest updates to [self-serve certification](doc:certification-testing) and [certification requirements](doc:certification). -During the keynote address, Roku announced a number of new platform features, including [Instant Resume](doc:instant-resume), the new Search feed spec 2.0, and [Developer Dashboard 2.0](doc:overview). Also announced was the release of the Independent Developer Kit (IDK) and [betan app feature](doc:channel-publishing-guide), and the sunsetting of non-certified apps. +During the keynote address, Roku announced a number of new platform features, including [Instant Resume](doc:instant-resume), the new Search feed spec 2.0, and [Developer Dashboard 2.0](doc:overview). Also announced was the release of the Independent Developer Kit (IDK) and [beta app feature](doc:channel-publishing-guide), and the sunsetting of non-certified apps. After the keynote, a series of 10 workshops and panel discussions were held on a number of key platform features, including [Roku SceneGraph](doc:core-concepts), [Roku Pay](doc:roku-pay), [Roku Advertising Framework (RAF)](doc:advertising), [voice keyboards](doc:dynamic-keyboard-base), and the [standard dialog framework](doc:standard-dialog-framework-nodes). These workshops and panel discussions enabled the developer community to directly engage with members on Roku’s product and engineering teams.