Skip to content

Add Migration Guide for Media#123

Merged
addb merged 4 commits intomediafrom
migration_doc
Nov 22, 2023
Merged

Add Migration Guide for Media#123
addb merged 4 commits intomediafrom
migration_doc

Conversation

@addb
Copy link
Copy Markdown
Contributor

@addb addb commented Nov 22, 2023

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

yangyansong-adbe and others added 4 commits November 13, 2023 16:26
* Update migration guide with list of APIs on media and aep sdks

* format updates

* format fix

* Add toc and format updates

* Update format

* format updates

* Update samples

* Update format

* Update content

* update format

* Updates based on reviews

* format change

* Update content

* Update name

* update wording

* format fix

* Update typo

* Update typos in api comparison

* Add content to migration guid

* Updates based on reviews
@addb addb requested a review from praveek November 22, 2023 18:01
@addb addb linked an issue Nov 22, 2023 that may be closed by this pull request
@addb addb requested a review from stcheng-adobe November 22, 2023 18:02
@addb addb merged commit 959612b into media Nov 22, 2023
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think we had officially rename VHL SDK to Adobe Media SDK for Roku. Can we double check with PMs and see if they are ok with the names?

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.

Sure.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

One more suggestion. It might not be clear to people what are the different XDMs (e.g. playXDM) from the table until someone scroll down to example of each event type. Maybe it is easier to navigate if we have a link reference to each API section from the table. For example, sendMediaEvent(playXDM) will link to the trackPlay example.

Copy link
Copy Markdown

@stcheng-adobe stcheng-adobe left a comment

Choose a reason for hiding this comment

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

I like the format. Except the wrong placement of brightscipt definition in a few places.


**AEP SDK**

seekStartXDM = {
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Missing brightscript definition here and a few other places below.

@praveek praveek deleted the migration_doc branch December 13, 2023 23:10
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 Migration docs for migrating from Media heartbeats SDK

4 participants