Skip to content

Update API references for media tracking APIs#111

Merged
yangyansong-adbe merged 7 commits intoadobe:mediafrom
yangyansong-adbe:API_doc
Nov 14, 2023
Merged

Update API references for media tracking APIs#111
yangyansong-adbe merged 7 commits intoadobe:mediafrom
yangyansong-adbe:API_doc

Conversation

@yangyansong-adbe
Copy link
Copy Markdown
Contributor

No description provided.

@yangyansong-adbe yangyansong-adbe changed the base branch from media to main November 12, 2023 23:17
@yangyansong-adbe yangyansong-adbe changed the base branch from main to media November 12, 2023 23:17
@yangyansong-adbe yangyansong-adbe changed the title [WIP] Update API references for media tracking APIs Update API references for media tracking APIs Nov 13, 2023
@yangyansong-adbe yangyansong-adbe marked this pull request as ready for review November 13, 2023 20:51
> [!IMPORTANT]
> The AEP task node performs the core logic of the SDK. Typically, a Roku project maintains only one instance of the AEP task node.

It's recommended to first call AdobeAEPSDKInit() without passing an argument within the scene script. It initializes a new AEP task node and creates an associated SDK instance. Then, the task node instance can be retrieved via the getTaskNode() API.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is required right? Since if not then we need to provide the details on how to create their own taskNode of the type SDK requires.

Can we reword

Warning

It's required to initialize the first SDK instance without taskNode. Use the taskNode instance created along with the first SDK instance then onwards.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a sample:

Create SDK instance for different sub Scenes:
taskNode = aepsdk.getTaskNode()
newSDKInstance = AdobeSDKInit(taskNode)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do have a similar sample.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's too much to add multiple alerts here. I'd prefer to have only one important alert.

@yangyansong-adbe yangyansong-adbe merged commit a5fe47a into adobe:media Nov 14, 2023
@yangyansong-adbe yangyansong-adbe linked an issue Nov 16, 2023 that may be closed by this pull request
@yangyansong-adbe yangyansong-adbe deleted the API_doc branch January 16, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Media API reference documentation

3 participants